diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index a3780ba5..fd4e6921 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,4 +1,4 @@
# Documentation codeowner
-/docs/*.md @szaganek
-/docs/*.mdx @szaganek
+/docs/**/*.md @szaganek
+/docs/**/*.mdx @szaganek
diff --git a/.github/workflows/_check_code.yaml b/.github/workflows/_check_code.yaml
deleted file mode 100644
index 4d9569fd..00000000
--- a/.github/workflows/_check_code.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-name: Code checks
-
-on:
- # Runs when manually triggered from the GitHub UI.
- workflow_dispatch:
-
- # Runs when invoked by another workflow.
- workflow_call:
-
-permissions:
- contents: read
-
-jobs:
- actions_lint_check:
- name: Actions lint check
- runs-on: ubuntu-latest
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
- - name: Run actionlint
- uses: rhysd/actionlint@v1.7.11
-
- spell_check:
- name: Spell check
- runs-on: ubuntu-latest
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
- - name: Check spelling with typos
- uses: crate-ci/typos@v1
-
- lint_check:
- name: Lint check
- uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
- with:
- python_versions: '["3.11", "3.12", "3.13", "3.14"]'
-
- type_check:
- name: Type check
- uses: apify/workflows/.github/workflows/python_type_check.yaml@main
- with:
- python_versions: '["3.11", "3.12", "3.13", "3.14"]'
diff --git a/.github/workflows/_check_docs.yaml b/.github/workflows/_check_docs.yaml
deleted file mode 100644
index 893e0db0..00000000
--- a/.github/workflows/_check_docs.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-name: Doc checks
-
-on:
- # Runs when manually triggered from the GitHub UI.
- workflow_dispatch:
-
- # Runs when invoked by another workflow.
- workflow_call:
-
-permissions:
- contents: read
-
-jobs:
- doc_checks:
- name: Doc checks
- uses: apify/workflows/.github/workflows/python_docs_check.yaml@main
diff --git a/.github/workflows/_check_docstrings.yaml b/.github/workflows/_check_docstrings.yaml
deleted file mode 100644
index 91c6688c..00000000
--- a/.github/workflows/_check_docstrings.yaml
+++ /dev/null
@@ -1,39 +0,0 @@
-name: Docstrings checks
-
-on:
- # Runs when manually triggered from the GitHub UI.
- workflow_dispatch:
-
- # Runs when invoked by another workflow.
- workflow_call:
-
-permissions:
- contents: read
-
-env:
- PYTHON_VERSION: 3.14
-
-jobs:
- docstrings_checks:
- name: Docstrings checks
- runs-on: ubuntu-latest
-
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
-
- - name: Set up Python
- uses: actions/setup-python@v6
- with:
- python-version: ${{ env.PYTHON_VERSION }}
-
- - name: Set up uv package manager
- uses: astral-sh/setup-uv@v7
- with:
- python-version: ${{ env.PYTHON_VERSION }}
-
- - name: Install dependencies
- run: uv run poe install-dev
-
- - name: Async docstrings check
- run: uv run poe check-docstrings
diff --git a/.github/workflows/_check_package.yaml b/.github/workflows/_check_package.yaml
deleted file mode 100644
index d5e7b055..00000000
--- a/.github/workflows/_check_package.yaml
+++ /dev/null
@@ -1,38 +0,0 @@
-name: Package check
-
-on:
- # Runs when manually triggered from the GitHub UI.
- workflow_dispatch:
-
- # Runs when invoked by another workflow.
- workflow_call:
-
-permissions:
- contents: read
-
-jobs:
- package_check:
- name: Package check
- runs-on: ubuntu-latest
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
-
- - name: Set up uv package manager
- uses: astral-sh/setup-uv@v8.1.0
- with:
- python-version: "3.14"
-
- - name: Build sdist and wheel
- run: uv run poe build
-
- - name: Verify built package
- uses: apify/actions/python-package-check@v1.1.0
- with:
- package_name: apify_client
- dist_dir: dist
- python_version: "3.14"
- smoke_code: |
- from apify_client import ApifyClient, ApifyClientAsync
- ApifyClient(token='x')
- ApifyClientAsync(token='x')
diff --git a/.github/workflows/_checks.yaml b/.github/workflows/_checks.yaml
new file mode 100644
index 00000000..c10cad12
--- /dev/null
+++ b/.github/workflows/_checks.yaml
@@ -0,0 +1,175 @@
+name: Checks
+
+on:
+ # Runs when invoked by another workflow. For manual runs, dispatch `CI (master)` instead — that wraps this
+ # workflow via `uses:`, so the resulting check-run names get the `Checks /` prefix that the manual release
+ # workflows look for via `wait-for-checks`.
+ workflow_call:
+ inputs:
+ run_tests:
+ description: Whether to run the test suites (unit, integration).
+ required: false
+ type: boolean
+ default: true
+
+permissions:
+ contents: read
+
+env:
+ PYTHON_VERSION: 3.14
+
+jobs:
+ actions_lint_check:
+ name: Actions lint check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+ - name: Run actionlint
+ uses: rhysd/actionlint@v1.7.12
+
+ spell_check:
+ name: Spell check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+ - name: Check spelling with typos
+ uses: crate-ci/typos@v1
+
+ lint_check:
+ name: Lint check
+ uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
+ with:
+ python_versions: '["3.11", "3.12", "3.13", "3.14"]'
+
+ type_check:
+ name: Type check
+ uses: apify/workflows/.github/workflows/python_type_check.yaml@main
+ with:
+ python_versions: '["3.11", "3.12", "3.13", "3.14"]'
+
+ docstrings_check:
+ name: Docstrings check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up Python
+ uses: actions/setup-python@v6
+ with:
+ python-version: ${{ env.PYTHON_VERSION }}
+
+ - name: Set up uv package manager
+ uses: astral-sh/setup-uv@v8.2.0
+ with:
+ python-version: ${{ env.PYTHON_VERSION }}
+
+ - name: Install dependencies
+ run: uv run poe install-dev
+
+ - name: Async docstrings check
+ run: uv run poe check-docstrings
+
+ unit_tests:
+ name: Unit tests
+ if: inputs.run_tests
+ uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
+ secrets: inherit
+ with:
+ python_versions: '["3.11", "3.12", "3.13", "3.14"]'
+ operating_systems: '["ubuntu-latest", "windows-latest"]'
+ python_version_for_codecov: "3.14"
+ operating_system_for_codecov: ubuntu-latest
+ tests_concurrency: "16"
+
+ # Integration tests are inlined (not calling the reusable workflow) to avoid GitHub's compile-time secret
+ # validation for nested reusable workflows, which fails on fork PRs where repo secrets are not available.
+ integration_tests:
+ name: Integration tests (${{ matrix.python-version }}, ${{ matrix.os }})
+ if: >-
+ ${{
+ inputs.run_tests && (
+ (github.event_name == 'pull_request' && github.event.pull_request.head.repo.owner.login == 'apify') ||
+ (github.event_name == 'push' && github.ref == 'refs/heads/master') ||
+ github.event_name == 'workflow_dispatch'
+ )
+ }}
+
+ strategy:
+ matrix:
+ os: ["ubuntu-latest"]
+ python-version: ["3.11", "3.14"]
+
+ runs-on: ${{ matrix.os }}
+
+ env:
+ TESTS_CONCURRENCY: "16"
+ CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v6
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: Set up uv package manager
+ uses: astral-sh/setup-uv@v8.2.0
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: Install Python dependencies
+ run: uv run poe install-dev
+
+ - name: Run integration tests
+ run: uv run poe integration-tests-cov
+ env:
+ APIFY_TEST_USER_API_TOKEN: ${{ secrets.APIFY_TEST_USER_PYTHON_SDK_API_TOKEN }}
+ APIFY_TEST_USER_2_API_TOKEN: ${{ secrets.APIFY_TEST_USER_2_API_TOKEN }}
+
+ - name: Upload integration test coverage
+ if: >-
+ ${{
+ matrix.os == 'ubuntu-latest' &&
+ matrix.python-version == '3.14' &&
+ env.CODECOV_TOKEN != ''
+ }}
+ uses: codecov/codecov-action@v6
+ with:
+ token: ${{ env.CODECOV_TOKEN }}
+ files: coverage-integration.xml
+ flags: integration
+
+ package_check:
+ name: Package check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up uv package manager
+ uses: astral-sh/setup-uv@v8.2.0
+ with:
+ python-version: "3.14"
+
+ - name: Build sdist and wheel
+ run: uv run poe build
+
+ - name: Verify built package
+ uses: apify/actions/python-package-check@v1.2.0
+ with:
+ package_name: apify_client
+ dist_dir: dist
+ python_version: "3.14"
+ smoke_code: |
+ from apify_client import ApifyClient, ApifyClientAsync
+ ApifyClient(token='x')
+ ApifyClientAsync(token='x')
+
+ doc_check:
+ name: Doc check
+ uses: apify/workflows/.github/workflows/python_docs_check.yaml@main
diff --git a/.github/workflows/_tests.yaml b/.github/workflows/_tests.yaml
deleted file mode 100644
index e9d4a791..00000000
--- a/.github/workflows/_tests.yaml
+++ /dev/null
@@ -1,81 +0,0 @@
-name: Tests
-
-on:
- # Runs when manually triggered from the GitHub UI.
- workflow_dispatch:
-
- # Runs when invoked by another workflow.
- workflow_call:
-
-permissions:
- contents: read
-
-jobs:
- unit_tests:
- name: Unit tests
- uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
- secrets: inherit
- with:
- python_versions: '["3.11", "3.12", "3.13", "3.14"]'
- operating_systems: '["ubuntu-latest", "windows-latest"]'
- python_version_for_codecov: "3.14"
- operating_system_for_codecov: ubuntu-latest
- tests_concurrency: "16"
-
- # Integration tests are inlined (not calling the reusable workflow) to avoid GitHub's compile-time secret
- # validation for nested reusable workflows, which fails on fork PRs where repo secrets are not available.
- integration_tests:
- name: Integration tests (${{ matrix.python-version }}, ${{ matrix.os }})
- if: >-
- ${{
- (github.event_name == 'pull_request' && github.event.pull_request.head.repo.owner.login == 'apify') ||
- (github.event_name == 'push' && github.ref == 'refs/heads/master') ||
- github.event_name == 'workflow_dispatch'
- }}
-
- strategy:
- matrix:
- os: ["ubuntu-latest"]
- python-version: ["3.11", "3.14"]
-
- runs-on: ${{ matrix.os }}
-
- env:
- TESTS_CONCURRENCY: "16"
- CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
-
- - name: Set up Python ${{ matrix.python-version }}
- uses: actions/setup-python@v6
- with:
- python-version: ${{ matrix.python-version }}
-
- - name: Set up uv package manager
- uses: astral-sh/setup-uv@v7
- with:
- python-version: ${{ matrix.python-version }}
-
- - name: Install Python dependencies
- run: uv run poe install-dev
-
- - name: Run integration tests
- run: uv run poe integration-tests-cov
- env:
- APIFY_TEST_USER_API_TOKEN: ${{ secrets.APIFY_TEST_USER_PYTHON_SDK_API_TOKEN }}
- APIFY_TEST_USER_2_API_TOKEN: ${{ secrets.APIFY_TEST_USER_2_API_TOKEN }}
-
- - name: Upload integration test coverage
- if: >-
- ${{
- matrix.os == 'ubuntu-latest' &&
- matrix.python-version == '3.14' &&
- env.CODECOV_TOKEN != ''
- }}
- uses: codecov/codecov-action@v6
- with:
- token: ${{ env.CODECOV_TOKEN }}
- files: coverage-integration.xml
- flags: integration
diff --git a/.github/workflows/manual_regenerate_models.yaml b/.github/workflows/manual_regenerate_models.yaml
index 93433ab9..b32786cf 100644
--- a/.github/workflows/manual_regenerate_models.yaml
+++ b/.github/workflows/manual_regenerate_models.yaml
@@ -1,4 +1,4 @@
-# This workflow regenerates Pydantic models and TypedDicts (src/apify_client/_{models,typeddicts}_generated.py) from the OpenAPI spec.
+# This workflow regenerates Pydantic models, TypedDicts, and Literal aliases (src/apify_client/_{models,typeddicts,literals}.py) from the OpenAPI spec.
#
# It can be triggered in two ways:
# 1. Automatically via workflow_dispatch from the apify-docs CI pipeline.
@@ -63,15 +63,20 @@ jobs:
with:
token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
- # If the branch already exists on the remote (e.g. from a previous run, possibly with reviewer commits),
- # check it out to build on top of it instead of starting fresh.
- - name: Switch to existing branch or create a new one
+ # If the branch already exists on the remote (e.g. from a previous run, possibly with reviewer
+ # commits), check it out so regeneration builds on top of it. Otherwise stay on the default
+ # branch and let the signed-commit step below create the remote branch — its create-branch
+ # flow does `git fetch ... $BRANCH:refs/heads/$BRANCH` which fails if $BRANCH is already
+ # checked out locally.
+ - name: Set up branch
+ id: branch-setup
run: |
if git ls-remote --exit-code --heads origin "$BRANCH" > /dev/null 2>&1; then
- git fetch origin "$BRANCH"
+ git fetch origin "$BRANCH":"$BRANCH"
git switch "$BRANCH"
+ echo "create_branch=false" >> "$GITHUB_OUTPUT"
else
- git switch -c "$BRANCH"
+ echo "create_branch=true" >> "$GITHUB_OUTPUT"
fi
# Download the pre-built OpenAPI spec artifact from the apify-docs workflow run.
@@ -87,7 +92,7 @@ jobs:
github-token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
- name: Set up uv
- uses: astral-sh/setup-uv@v7
+ uses: astral-sh/setup-uv@v8.2.0
with:
python-version: "3.14"
@@ -106,13 +111,13 @@ jobs:
- name: Commit model changes
id: commit
- uses: apify/actions/signed-commit@v1.0.0
+ uses: apify/actions/signed-commit@v1.2.0
with:
message: ${{ env.TITLE }}
- add: 'src/apify_client/_*_generated.py'
+ add: 'src/apify_client/_models.py src/apify_client/_typeddicts.py src/apify_client/_literals.py'
github-token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
branch: ${{ env.BRANCH }}
- create-branch: 'true'
+ create-branch: ${{ steps.branch-setup.outputs.create_branch }}
- name: Create or update PR
if: steps.commit.outputs.committed == 'true'
diff --git a/.github/workflows/manual_release_beta.yaml b/.github/workflows/manual_release_beta.yaml
index 46b07c1c..29ee15be 100644
--- a/.github/workflows/manual_release_beta.yaml
+++ b/.github/workflows/manual_release_beta.yaml
@@ -16,14 +16,28 @@ permissions:
contents: read
jobs:
+ wait_for_checks:
+ # Gate the release on the `Checks` workflow already succeeding on this commit (run by `on_master.yaml`).
+ name: Wait for required checks
+ runs-on: ubuntu-latest
+ permissions:
+ checks: read
+ steps:
+ - name: Wait for checks
+ uses: apify/actions/wait-for-checks@v1.2.0
+ with:
+ ref: ${{ github.sha }}
+ check-regexp: '^Checks'
+
release_prepare:
name: Release prepare
+ needs: [wait_for_checks]
runs-on: ubuntu-latest
outputs:
version_number: ${{ steps.release_prepare.outputs.version_number }}
changelog: ${{ steps.release_prepare.outputs.changelog }}
steps:
- - uses: apify/actions/git-cliff-release@v1.1.2
+ - uses: apify/actions/git-cliff-release@v1.2.0
id: release_prepare
name: Release prepare
with:
@@ -53,7 +67,7 @@ jobs:
url: https://pypi.org/project/apify-client
steps:
- name: Prepare distribution
- uses: apify/actions/prepare-pypi-distribution@v1.1.2
+ uses: apify/actions/prepare-pypi-distribution@v1.2.0
with:
package_name: apify-client
is_prerelease: "yes"
@@ -61,7 +75,7 @@ jobs:
ref: ${{ needs.changelog_update.outputs.changelog_commitish }}
- name: Verify built package
- uses: apify/actions/python-package-check@v1.1.0
+ uses: apify/actions/python-package-check@v1.2.0
with:
package_name: apify_client
dist_dir: dist
@@ -82,5 +96,6 @@ jobs:
contents: write
pages: write
id-token: write
+ checks: read
uses: ./.github/workflows/manual_release_docs.yaml
secrets: inherit
diff --git a/.github/workflows/manual_release_docs.yaml b/.github/workflows/manual_release_docs.yaml
index 9c4735e1..3f4a3cd2 100644
--- a/.github/workflows/manual_release_docs.yaml
+++ b/.github/workflows/manual_release_docs.yaml
@@ -3,9 +3,21 @@ name: Release docs
on:
# Runs when manually triggered from the GitHub UI.
workflow_dispatch:
+ inputs:
+ ref:
+ description: Commit SHA or ref to build the docs from. If empty, the triggering ref is used.
+ required: false
+ type: string
+ default: ""
# Runs when invoked by another workflow.
workflow_call:
+ inputs:
+ ref:
+ description: Commit SHA or ref to build the docs from. If empty, the triggering ref is used.
+ required: false
+ type: string
+ default: ""
permissions:
contents: read
@@ -23,12 +35,23 @@ jobs:
contents: write
pages: write
id-token: write
+ checks: read
runs-on: ubuntu-latest
steps:
+ # Gate manual dispatches on the `Checks` workflow already succeeding on this commit (run by `on_master.yaml`);
+ # skipped when called from another workflow.
+ - name: Wait for checks
+ if: github.event_name == 'workflow_dispatch'
+ uses: apify/actions/wait-for-checks@v1.2.0
+ with:
+ ref: ${{ github.sha }}
+ check-regexp: '^Checks'
+
- name: Checkout repository
uses: actions/checkout@v6
with:
+ ref: ${{ inputs.ref }}
token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
- name: Set up Node
@@ -42,7 +65,7 @@ jobs:
python-version: ${{ env.PYTHON_VERSION }}
- name: Set up uv package manager
- uses: astral-sh/setup-uv@v7
+ uses: astral-sh/setup-uv@v8.2.0
with:
python-version: ${{ env.PYTHON_VERSION }}
@@ -50,7 +73,7 @@ jobs:
run: uv run poe install-dev
- name: Install pnpm and website dependencies
- uses: apify/actions/pnpm-install@v1.1.2
+ uses: apify/actions/pnpm-install@v1.2.0
with:
working-directory: website
@@ -58,7 +81,7 @@ jobs:
run: uv run poe update-docs-theme
- name: Commit the updated package.json and lockfile
- uses: apify/actions/signed-commit@v1.0.0
+ uses: apify/actions/signed-commit@v1.2.0
with:
message: "chore: Automatic docs theme update [skip ci]"
add: 'website/package.json website/pnpm-lock.yaml'
@@ -75,7 +98,7 @@ jobs:
uses: actions/configure-pages@v6
- name: Upload GitHub Pages artifact
- uses: actions/upload-pages-artifact@v4
+ uses: actions/upload-pages-artifact@v5
with:
path: ./website/build
diff --git a/.github/workflows/manual_release_stable.yaml b/.github/workflows/manual_release_stable.yaml
index 70e116a8..3a8af537 100644
--- a/.github/workflows/manual_release_stable.yaml
+++ b/.github/workflows/manual_release_stable.yaml
@@ -29,13 +29,22 @@ permissions:
contents: read
jobs:
- code_checks:
- name: Code checks
- uses: ./.github/workflows/_check_code.yaml
+ wait_for_checks:
+ # Gate the release on the `Checks` workflow already succeeding on this commit (run by `on_master.yaml`).
+ name: Wait for required checks
+ runs-on: ubuntu-latest
+ permissions:
+ checks: read
+ steps:
+ - name: Wait for checks
+ uses: apify/actions/wait-for-checks@v1.2.0
+ with:
+ ref: ${{ github.sha }}
+ check-regexp: '^Checks'
release_prepare:
name: Release prepare
- needs: [code_checks]
+ needs: [wait_for_checks]
runs-on: ubuntu-latest
outputs:
version_number: ${{ steps.release_prepare.outputs.version_number }}
@@ -43,7 +52,7 @@ jobs:
changelog: ${{ steps.release_prepare.outputs.changelog }}
release_notes: ${{ steps.release_prepare.outputs.release_notes }}
steps:
- - uses: apify/actions/git-cliff-release@v1.1.2
+ - uses: apify/actions/git-cliff-release@v1.2.0
name: Release prepare
id: release_prepare
with:
@@ -72,7 +81,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: GitHub release
- uses: softprops/action-gh-release@v2
+ uses: softprops/action-gh-release@v3
with:
tag_name: ${{ needs.release_prepare.outputs.tag_name }}
name: ${{ needs.release_prepare.outputs.version_number }}
@@ -91,7 +100,7 @@ jobs:
url: https://pypi.org/project/apify-client
steps:
- name: Prepare distribution
- uses: apify/actions/prepare-pypi-distribution@v1.1.2
+ uses: apify/actions/prepare-pypi-distribution@v1.2.0
with:
package_name: apify-client
is_prerelease: ""
@@ -99,7 +108,7 @@ jobs:
ref: ${{ needs.changelog_update.outputs.changelog_commitish }}
- name: Verify built package
- uses: apify/actions/python-package-check@v1.1.0
+ uses: apify/actions/python-package-check@v1.2.0
with:
package_name: apify_client
dist_dir: dist
@@ -118,7 +127,12 @@ jobs:
needs: [release_prepare, changelog_update, pypi_publish]
permissions:
contents: write
+ checks: read
uses: ./.github/workflows/manual_version_docs.yaml
+ with:
+ # Pass the bumped version explicitly — the job's checkout uses the dispatch ref (pre-bump),
+ # so `uv version --short` from pyproject.toml would return the old version.
+ version_number: ${{ needs.release_prepare.outputs.version_number }}
secrets: inherit
doc_release:
@@ -128,5 +142,12 @@ jobs:
contents: write
pages: write
id-token: write
+ checks: read
uses: ./.github/workflows/manual_release_docs.yaml
+ with:
+ # Build from the up-to-date branch tip, not the workflow-dispatch ref. The default checkout
+ # pins to the dispatch commit (pre-bump), which predates the changelog finalization and the
+ # version snapshot pushed earlier in this run — so the docs would be redeployed from stale
+ # content (e.g. the changelog stuck at "not yet released").
+ ref: ${{ github.ref_name }}
secrets: inherit
diff --git a/.github/workflows/manual_version_docs.yaml b/.github/workflows/manual_version_docs.yaml
index 12b58bc1..a64057fb 100644
--- a/.github/workflows/manual_version_docs.yaml
+++ b/.github/workflows/manual_version_docs.yaml
@@ -3,9 +3,21 @@ name: Version docs
on:
# Runs when manually triggered from the GitHub UI.
workflow_dispatch:
+ inputs:
+ version_number:
+ description: Version to snapshot (e.g. "1.0.0"). If empty, the current version in pyproject.toml is used.
+ required: false
+ type: string
+ default: ""
# Runs when invoked by another workflow.
workflow_call:
+ inputs:
+ version_number:
+ description: Version to snapshot (e.g. "1.0.0"). If empty, the current version in pyproject.toml is used.
+ required: false
+ type: string
+ default: ""
concurrency:
group: version-docs
@@ -24,8 +36,18 @@ jobs:
runs-on: ubuntu-latest
permissions:
contents: write
+ checks: read
steps:
+ # Gate manual dispatches on the `Checks` workflow already succeeding on this commit (run by `on_master.yaml`);
+ # skipped when called from another workflow.
+ - name: Wait for checks
+ if: github.event_name == 'workflow_dispatch'
+ uses: apify/actions/wait-for-checks@v1.2.0
+ with:
+ ref: ${{ github.sha }}
+ check-regexp: '^Checks'
+
- name: Checkout repository
uses: actions/checkout@v6
with:
@@ -42,7 +64,7 @@ jobs:
python-version: ${{ env.PYTHON_VERSION }}
- name: Set up uv package manager
- uses: astral-sh/setup-uv@v7
+ uses: astral-sh/setup-uv@v8.2.0
with:
python-version: ${{ env.PYTHON_VERSION }}
@@ -50,17 +72,25 @@ jobs:
run: uv run poe install-dev
- name: Install pnpm and website dependencies
- uses: apify/actions/pnpm-install@v1.1.2
+ uses: apify/actions/pnpm-install@v1.2.0
with:
working-directory: website
- name: Snapshot the current version
id: snapshot
+ env:
+ INPUT_VERSION: ${{ inputs.version_number }}
run: |
cd website
- # Extract version from pyproject.toml.
- FULL_VERSION="$(uv version --short)"
+ # Prefer the explicit input (passed by the release workflow after the version bump).
+ # Fall back to pyproject.toml only when run manually without an input — this avoids
+ # the stale-checkout pitfall where the bumped version isn't visible to this job.
+ if [[ -n "$INPUT_VERSION" ]]; then
+ FULL_VERSION="$INPUT_VERSION"
+ else
+ FULL_VERSION="$(uv version --short)"
+ fi
MAJOR_MINOR_VERSION="$(echo "$FULL_VERSION" | cut -d. -f1-2)"
MAJOR_VERSION="$(echo "$FULL_VERSION" | cut -d. -f1)"
echo "version=$FULL_VERSION" >> "$GITHUB_OUTPUT"
@@ -93,7 +123,7 @@ jobs:
uv run pnpm exec docusaurus api:version "$MAJOR_MINOR_VERSION"
- name: Commit and push versioned docs
- uses: apify/actions/signed-commit@v1.0.0
+ uses: apify/actions/signed-commit@v1.2.0
with:
message: "docs: Version docs for v${{ steps.snapshot.outputs.version }} [skip ci]"
add: 'website/versioned_docs website/versioned_sidebars website/versions.json'
diff --git a/.github/workflows/on_issue.yaml b/.github/workflows/on_issue.yaml
index db6a3047..6799d738 100644
--- a/.github/workflows/on_issue.yaml
+++ b/.github/workflows/on_issue.yaml
@@ -18,7 +18,7 @@ jobs:
steps:
# Add the "t-tooling" label to all new issues
- - uses: actions/github-script@v8
+ - uses: actions/github-script@v9
with:
script: |
github.rest.issues.addLabels({
diff --git a/.github/workflows/on_master.yaml b/.github/workflows/on_master.yaml
index 8ee39f3d..2e9213ce 100644
--- a/.github/workflows/on_master.yaml
+++ b/.github/workflows/on_master.yaml
@@ -7,59 +7,62 @@ on:
tags-ignore:
- "**" # Ignore all tags to avoid duplicate executions triggered by tag pushes.
+ # Allow re-running the Checks manually. Release jobs below are gated on `github.event_name == 'push'`
+ # so they never fire on manual dispatch.
+ workflow_dispatch:
+ inputs:
+ run_tests:
+ description: Whether to run the test suites (unit, integration).
+ required: false
+ type: boolean
+ default: true
+
permissions:
contents: read
jobs:
- doc_checks:
- name: Doc checks
- uses: ./.github/workflows/_check_docs.yaml
+ checks:
+ name: Checks
+ uses: ./.github/workflows/_checks.yaml
+ with:
+ # On push: skip the test suites for docs-only commits — they don't change runtime behavior.
+ # On manual dispatch: honor the input.
+ run_tests: ${{ github.event_name == 'push' && !startsWith(github.event.head_commit.message, 'docs') || github.event_name == 'workflow_dispatch' && inputs.run_tests }}
+ secrets: inherit
doc_release:
- # Skip this for non-"docs" commits.
- if: startsWith(github.event.head_commit.message, 'docs')
+ # Only on push, and only for "docs" commits.
+ if: github.event_name == 'push' && startsWith(github.event.head_commit.message, 'docs')
name: Doc release
- needs: [doc_checks]
+ needs: [checks]
permissions:
contents: write
pages: write
id-token: write
+ checks: read
uses: ./.github/workflows/manual_release_docs.yaml
secrets: inherit
- code_checks:
- name: Code checks
- uses: ./.github/workflows/_check_code.yaml
-
- docstrings_checks:
- name: Docstrings checks
- uses: ./.github/workflows/_check_docstrings.yaml
-
- tests:
- # Skip this for "docs" commits.
- if: "!startsWith(github.event.head_commit.message, 'docs')"
- name: Tests
- uses: ./.github/workflows/_tests.yaml
- secrets: inherit
-
# The beta release is dispatched as a separate workflow run (instead of calling `manual_release_beta.yaml` via `uses:`)
# because PyPI's Trusted Publishing does not currently support reusable workflows.
# See: https://docs.pypi.org/trusted-publishers/troubleshooting/#reusable-workflows-on-github
beta_release:
- # Run this only for "feat", "fix", "perf", "refactor" and "style" commits.
+ # Only on push, and only for "feat", "fix", "perf", "refactor" and "style" commits.
if: >-
- startsWith(github.event.head_commit.message, 'feat') ||
- startsWith(github.event.head_commit.message, 'fix') ||
- startsWith(github.event.head_commit.message, 'perf') ||
- startsWith(github.event.head_commit.message, 'refactor') ||
- startsWith(github.event.head_commit.message, 'style')
+ github.event_name == 'push' && (
+ startsWith(github.event.head_commit.message, 'feat') ||
+ startsWith(github.event.head_commit.message, 'fix') ||
+ startsWith(github.event.head_commit.message, 'perf') ||
+ startsWith(github.event.head_commit.message, 'refactor') ||
+ startsWith(github.event.head_commit.message, 'style')
+ )
name: Beta release
- needs: [code_checks, docstrings_checks, tests]
+ needs: [checks]
runs-on: ubuntu-latest
permissions:
actions: write # Required by execute-workflow.
steps:
- name: Dispatch beta release workflow
- uses: apify/actions/execute-workflow@v1.1.2
+ uses: apify/actions/execute-workflow@v1.2.0
with:
workflow: manual_release_beta.yaml
diff --git a/.github/workflows/on_pull_request.yaml b/.github/workflows/on_pull_request.yaml
index a66bdee7..0ea3d27d 100644
--- a/.github/workflows/on_pull_request.yaml
+++ b/.github/workflows/on_pull_request.yaml
@@ -17,23 +17,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- doc_checks:
- name: Doc checks
- uses: ./.github/workflows/_check_docs.yaml
-
- code_checks:
- name: Code checks
- uses: ./.github/workflows/_check_code.yaml
-
- docstrings_checks:
- name: Docstrings checks
- uses: ./.github/workflows/_check_docstrings.yaml
-
- package_check:
- name: Package check
- uses: ./.github/workflows/_check_package.yaml
-
- tests:
- name: Tests
- uses: ./.github/workflows/_tests.yaml
+ checks:
+ name: Checks
+ uses: ./.github/workflows/_checks.yaml
secrets: inherit
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0bc12852..71ad3aed 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,25 +3,49 @@
All notable changes to this project will be documented in this file.
-## 2.5.1 - **not yet released**
+## 3.0.3 - **not yet released**
+
+
+
+## [3.0.2](https://github.com/apify/apify-client-python/releases/tag/v3.0.2) (2026-05-26)
+
+### 🐛 Bug Fixes
+
+- Add missing response fields returned by the live API ([#821](https://github.com/apify/apify-client-python/pull/821)) ([e794411](https://github.com/apify/apify-client-python/commit/e794411dd3935cd09941096abc9767f33c4a4cf9)) by [@apify-service-account](https://github.com/apify-service-account)
+- Prevent StreamedLog stop() from hanging on a silent stream ([#825](https://github.com/apify/apify-client-python/pull/825)) ([c15cb1b](https://github.com/apify/apify-client-python/commit/c15cb1bb2702120dd6fabe154a4b3d879248aafa)) by [@vdusek](https://github.com/vdusek)
+- Flush StreamedLogAsync tail when stop() cancels the task ([#754](https://github.com/apify/apify-client-python/pull/754)) ([ea23338](https://github.com/apify/apify-client-python/commit/ea2333822937c4ad9b72fbba63e6fd7b52343055)) by [@vdusek](https://github.com/vdusek)
+
+
+## [3.0.1](https://github.com/apify/apify-client-python/releases/tag/v3.0.1) (2026-05-22)
+
+### 🐛 Bug Fixes
+
+- Add new API error codes and drop obsolete UnknownBuildTagError model ([#813](https://github.com/apify/apify-client-python/pull/813)) ([d1e2020](https://github.com/apify/apify-client-python/commit/d1e202087a37e6ab5048b0b8724cc73a3769ea8e)) by [@apify-service-account](https://github.com/apify-service-account)
+- Add support for tiered pricing in Actor charge events ([#818](https://github.com/apify/apify-client-python/pull/818)) ([c3ea8c1](https://github.com/apify/apify-client-python/commit/c3ea8c10ae1d606fd3954177b690703f220ae857)) by [@apify-service-account](https://github.com/apify-service-account), closes [#811](https://github.com/apify/apify-client-python/issues/811)
+- Allow 128MB memory limits and add CI to RunOrigin in models ([#819](https://github.com/apify/apify-client-python/pull/819)) ([01eb993](https://github.com/apify/apify-client-python/commit/01eb9934467e17e669c51d1c1e6f7e0bce1a608e)) by [@apify-service-account](https://github.com/apify-service-account)
+
+
+## [3.0.0](https://github.com/apify/apify-client-python/releases/tag/v3.0.0) (2026-05-20)
+
+- Check out the [Upgrading guide](https://docs.apify.com/api/client/python/docs/upgrading/upgrading-to-v3) to ensure a smooth update.
### 🚀 Features
-- [**breaking**] Make HTTP client pluggable with abstract base classes ([#641](https://github.com/apify/apify-client-python/pull/641)) ([5ae33a0](https://github.com/apify/apify-client-python/commit/5ae33a0a801fdacd0c456a8630fea053f9df6550)) by [@vdusek](https://github.com/vdusek), closes [#416](https://github.com/apify/apify-client-python/issues/416)
+- [**breaking**] Introduce fully typed clients ([#604](https://github.com/apify/apify-client-python/pull/604)) ([81ee194](https://github.com/apify/apify-client-python/commit/81ee1943b400b49797868fe4dfa52d1662e09370)) by [@vdusek](https://github.com/vdusek), closes [#21](https://github.com/apify/apify-client-python/issues/21), [#481](https://github.com/apify/apify-client-python/issues/481)
- [**breaking**] Introduce tiered timeout system with per-endpoint configuration ([#653](https://github.com/apify/apify-client-python/pull/653)) ([723ec6e](https://github.com/apify/apify-client-python/commit/723ec6e5954474767a5ecbf4902d9b62f7d214f8)) by [@vdusek](https://github.com/vdusek)
+- [**breaking**] Generate Literal type aliases instead of StrEnum classes ([#759](https://github.com/apify/apify-client-python/pull/759)) ([2bf5a75](https://github.com/apify/apify-client-python/commit/2bf5a75f38a74a48c5c9a9682d9eaf330da27935)) by [@vdusek](https://github.com/vdusek), closes [#576](https://github.com/apify/apify-client-python/issues/576)
+- Make HTTP client pluggable with abstract base classes ([#641](https://github.com/apify/apify-client-python/pull/641)) ([5ae33a0](https://github.com/apify/apify-client-python/commit/5ae33a0a801fdacd0c456a8630fea053f9df6550)) by [@vdusek](https://github.com/vdusek), closes [#416](https://github.com/apify/apify-client-python/issues/416)
- Accept Pydantic models as alternatives to dicts in resource client methods ([#663](https://github.com/apify/apify-client-python/pull/663)) ([b778c20](https://github.com/apify/apify-client-python/commit/b778c2040228ff9f5a97765de10535cec3f0353e)) by [@vdusek](https://github.com/vdusek), closes [#421](https://github.com/apify/apify-client-python/issues/421)
- Add ownership parameter to storage collection listing methods ([#696](https://github.com/apify/apify-client-python/pull/696)) ([51a92a3](https://github.com/apify/apify-client-python/commit/51a92a31dac5dd433acfaea76155011d0892d8c8)) by [@nmanerikar](https://github.com/nmanerikar)
- Add filter and cursor parameters to list_requests method ([#743](https://github.com/apify/apify-client-python/pull/743)) ([3445ff7](https://github.com/apify/apify-client-python/commit/3445ff74e61d5f1f9a964f2ee3c14d198298f709)) by [@mvolfik](https://github.com/mvolfik)
-- Add ApifyApiError subclasses grouped by HTTP status ([#737](https://github.com/apify/apify-client-python/pull/737)) ([a6daff7](https://github.com/apify/apify-client-python/commit/a6daff754e5e1af8a6230f4c504db24a246c734f)) by [@vdusek](https://github.com/vdusek)
+- Add ApifyApiError subclasses grouped by HTTP status ([#737](https://github.com/apify/apify-client-python/pull/737)) ([a6daff7](https://github.com/apify/apify-client-python/commit/a6daff754e5e1af8a6230f4c504db24a246c734f)) by [@vdusek](https://github.com/vdusek), closes [#423](https://github.com/apify/apify-client-python/issues/423)
- Generate TypedDict types for input-side models ([#738](https://github.com/apify/apify-client-python/pull/738)) ([2fd66d0](https://github.com/apify/apify-client-python/commit/2fd66d0adf253dff470f40d0bfdbc620da0ed608)) by [@vdusek](https://github.com/vdusek), closes [#666](https://github.com/apify/apify-client-python/issues/666)
-- Generate Literal type aliases instead of StrEnum classes ([#759](https://github.com/apify/apify-client-python/pull/759)) ([2bf5a75](https://github.com/apify/apify-client-python/commit/2bf5a75f38a74a48c5c9a9682d9eaf330da27935)) by [@vdusek](https://github.com/vdusek), closes [#576](https://github.com/apify/apify-client-python/issues/576)
- Add iterate methods for paginated collections ([#771](https://github.com/apify/apify-client-python/pull/771)) ([3f3129c](https://github.com/apify/apify-client-python/commit/3f3129c729791d0e012070a77d7245b44a1f1180)) by [@Pijukatel](https://github.com/Pijukatel), closes [#539](https://github.com/apify/apify-client-python/issues/539)
- Accept camelCase keys in input TypedDicts ([#793](https://github.com/apify/apify-client-python/pull/793)) ([7a579bf](https://github.com/apify/apify-client-python/commit/7a579bf2083e93092cfa5ba411c1c38d5cba2085)) by [@vdusek](https://github.com/vdusek), closes [#756](https://github.com/apify/apify-client-python/issues/756)
- Expose WebhooksList and JsonSerializable from public types module ([#800](https://github.com/apify/apify-client-python/pull/800)) ([104011c](https://github.com/apify/apify-client-python/commit/104011c28bc08197d61e384126a4403acc3579f1)) by [@vdusek](https://github.com/vdusek)
### 🐛 Bug Fixes
-- Guard integration test resource names against 63-char API limit ([#729](https://github.com/apify/apify-client-python/pull/729)) ([47a7a69](https://github.com/apify/apify-client-python/commit/47a7a6967e28c7042fa8e75cd4c138356495fa2c)) by [@vdusek](https://github.com/vdusek)
- Prevent `_prepare_request_call` from mutating caller's headers dict ([#746](https://github.com/apify/apify-client-python/pull/746)) ([d553162](https://github.com/apify/apify-client-python/commit/d5531621535f5a491be5b5791ea4b80e46de1405)) by [@vdusek](https://github.com/vdusek)
- Don't block StatusMessageWatcher exit with 6s sleep on exception ([#753](https://github.com/apify/apify-client-python/pull/753)) ([48f5037](https://github.com/apify/apify-client-python/commit/48f50378e92e2058ff8e5aaba45ef9e3a6e5f081)) by [@vdusek](https://github.com/vdusek)
- Treat naive datetime query params as UTC ([#752](https://github.com/apify/apify-client-python/pull/752)) ([9ab096a](https://github.com/apify/apify-client-python/commit/9ab096a7453080a3079c7459079f99a30bd6a7cb)) by [@vdusek](https://github.com/vdusek)
@@ -31,15 +55,20 @@ All notable changes to this project will be documented in this file.
### 🚜 Refactor
-- [**breaking**] Introduce fully typed clients ([#604](https://github.com/apify/apify-client-python/pull/604)) ([81ee194](https://github.com/apify/apify-client-python/commit/81ee1943b400b49797868fe4dfa52d1662e09370)) by [@vdusek](https://github.com/vdusek), closes [#21](https://github.com/apify/apify-client-python/issues/21), [#481](https://github.com/apify/apify-client-python/issues/481)
-- [**breaking**] Drop support for Python 3.10 ([#636](https://github.com/apify/apify-client-python/pull/636)) ([7895a4e](https://github.com/apify/apify-client-python/commit/7895a4e60145f490911044da4aa7e3c1c424d416)) by [@vdusek](https://github.com/vdusek)
- [**breaking**] Update default timeout tiers on non-storage resource clients ([#664](https://github.com/apify/apify-client-python/pull/664)) ([0b35bbe](https://github.com/apify/apify-client-python/commit/0b35bbe212a8a64c5aea5d5d813315252760b055)) by [@vdusek](https://github.com/vdusek)
-- [**breaking**] Use snake case for `actors().list(sort_by=...)` ([#736](https://github.com/apify/apify-client-python/pull/736)) ([eb70b64](https://github.com/apify/apify-client-python/commit/eb70b64eac86faba5cbe943845ad144ec0277896)) by [@vdusek](https://github.com/vdusek), closes [#700](https://github.com/apify/apify-client-python/issues/700)
- [**breaking**] Mark secondary arguments as keyword-only ([#766](https://github.com/apify/apify-client-python/pull/766)) ([4ca99fd](https://github.com/apify/apify-client-python/commit/4ca99fd6a442ad12adbdfc866e72543c0feaf96b)) by [@vdusek](https://github.com/vdusek)
- [**breaking**] Remove deprecated APIs ([#799](https://github.com/apify/apify-client-python/pull/799)) ([6e5df35](https://github.com/apify/apify-client-python/commit/6e5df3595e5f858d944887445a9019dea1008e97)) by [@vdusek](https://github.com/vdusek)
+### ⚙️ Miscellaneous Tasks
+
+- [**breaking**] Drop support for Python 3.10 ([#636](https://github.com/apify/apify-client-python/pull/636)) ([7895a4e](https://github.com/apify/apify-client-python/commit/7895a4e60145f490911044da4aa7e3c1c424d416)) by [@vdusek](https://github.com/vdusek)
+
+## [2.5.1](https://github.com/apify/apify-client-python/releases/tag/v2.5.1) (2026-05-20)
+
+### 🐛 Bug Fixes
+
+- Use DeprecationWarning for deprecated methods and arguments (#802) ([0d91e12](https://github.com/apify/apify-client-python/commit/0d91e129014369534a9a37078f90c8f81f8236a6))
-
## [2.5.0](https://github.com/apify/apify-client-python/releases/tag/v2.5.0) (2026-02-18)
### 🚀 Features
diff --git a/docs/01_introduction/index.mdx b/docs/01_introduction/index.mdx
index ab1ae5a7..59a04977 100644
--- a/docs/01_introduction/index.mdx
+++ b/docs/01_introduction/index.mdx
@@ -12,11 +12,11 @@ import CodeBlock from '@theme/CodeBlock';
import UsageAsyncExample from '!!raw-loader!./code/01_usage_async.py';
import UsageSyncExample from '!!raw-loader!./code/01_usage_sync.py';
-The Apify API client for Python is the official library to access the [Apify REST API](/api/v2) from your Python applications. It provides useful features like automatic retries and convenience functions that improve the experience of using the Apify API.
+The Apify API client for Python 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.
The client simplifies interaction with the Apify platform by providing:
-- Intuitive methods for working with [Actors](/platform/actors), [datasets](/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and other Apify resources
+- Intuitive methods for working with [Actors](https://docs.apify.com/platform/actors), [Datasets](https://docs.apify.com/platform/storage/dataset), [Key-value stores](https://docs.apify.com/platform/storage/key-value-store), and other Apify resources
- Both synchronous and asynchronous interfaces for flexible integration
- Built-in [retries with exponential backoff](../02_concepts/05_retries.mdx) for failed requests
- Comprehensive API coverage with JSON encoding (UTF-8) for all requests and responses
diff --git a/docs/04_upgrading/upgrading_to_v3.mdx b/docs/04_upgrading/upgrading_to_v3.mdx
index 12d0c586..7dc8617d 100644
--- a/docs/04_upgrading/upgrading_to_v3.mdx
+++ b/docs/04_upgrading/upgrading_to_v3.mdx
@@ -6,389 +6,115 @@ description: Breaking changes and migration guide from v2 to v3.
import ApiLink from '@theme/ApiLink';
-This page summarizes the breaking changes between Apify Python API Client v2.x and v3.0.
+This guide lists the breaking changes between Apify Python API Client v2.x and v3.0.
-## Python version support
+## Python 3.11+ required
-Support for Python 3.10 has been dropped. The Apify Python API Client v3.x now requires Python 3.11 or later. Make sure your environment is running a compatible version before upgrading.
+Support for Python 3.10 has been dropped. The Apify Python API Client v3.x now requires Python 3.11 or later — make sure your environment is on a compatible version before upgrading.
-## Fully typed clients
+## Typed responses
-Resource client methods now return [Pydantic](https://docs.pydantic.dev/latest/) models instead of plain dictionaries. This provides IDE autocompletion, type checking, and early validation of API responses.
-
-### Accessing response fields
-
-Before (v2):
+Methods now return [Pydantic](https://docs.pydantic.dev/latest/) models instead of dicts. Access fields with their snake_case attribute names.
```python
-from apify_client import ApifyClient
-
-client = ApifyClient(token='MY-APIFY-TOKEN')
-
-# v2 — methods returned plain dicts
run = client.actor('apify/hello-world').call(run_input={'key': 'value'})
-dataset_id = run['defaultDatasetId']
-status = run['status']
-```
-
-After (v3):
-
-```python
-from apify_client import ApifyClient
-client = ApifyClient(token='MY-APIFY-TOKEN')
+# Before
+dataset_id = run['defaultDatasetId']
-# v3 — methods return Pydantic models
-run = client.actor('apify/hello-world').call(run_input={'key': 'value'})
+# After
dataset_id = run.default_dataset_id
-status = run.status
-```
-
-All model classes are generated from the Apify OpenAPI specification and live in `apify_client._models` module. They are configured with `extra='allow'`, so any new fields added to the API in the future are preserved on the model instance. Fields are accessed using their Python snake_case names:
-
-:::warning
-The `apify_client._models`, `apify_client._typeddicts`, and `apify_client._literals` modules are internal. The examples below import from them for convenience, but use them at your own risk — their contents are regenerated from the OpenAPI specification and the public API of these modules is not stable across minor versions of `apify-client`.
-:::
-
-```python
-run.default_dataset_id # ✓ use snake_case attribute names
-run.id
-run.status
-```
-
-Models also use `populate_by_name=True`, which means you can use either the Python field name or the camelCase alias when **constructing** a model:
-
-```python
-from apify_client._models import Run
-
-# Both work when constructing models
-Run(default_dataset_id='abc') # Python field name
-Run(defaultDatasetId='abc') # camelCase API alias
-```
-
-### Exceptions
-
-Not every method returns a Pydantic model. Methods whose payloads are user-defined or inherently unstructured still return plain types:
-
-- `DatasetClient.list_items()` returns `DatasetItemsPage`, a dataclass whose `items` field is `list[dict[str, Any]]`, because the structure of dataset items is defined by the [Actor output schema](https://docs.apify.com/platform/actors/development/actor-definition/output-schema), which the API Client or SDK has no knowledge of.
-- `KeyValueStoreClient.get_record()` returns a `dict` with `key`, `value`, and `content_type` keys.
-
-### Pydantic models as method parameters
-
-Resource client methods that previously accepted only dictionaries for structured input now also accept Pydantic models. Existing code that passes dictionaries continues to work — this change is additive for callers, but is listed here because method type signatures have changed.
-
-Before (v2):
-
-```python
-rq_client.add_request({
- 'url': 'https://example.com',
- 'uniqueKey': 'https://example.com',
- 'method': 'GET',
-})
-```
-
-After (v3) — both forms are accepted:
-
-```python
-from apify_client._models import RequestDraft
-
-# Option 1: dict (still works)
-rq_client.add_request({
- 'url': 'https://example.com',
- 'uniqueKey': 'https://example.com',
- 'method': 'GET',
-})
-
-# Option 2: Pydantic model (new)
-rq_client.add_request(RequestDraft(
- url='https://example.com',
- unique_key='https://example.com',
- method='GET',
-))
-```
-
-Model input is available on methods such as `RequestQueueClient.add_request()`, `RequestQueueClient.batch_add_requests()`, `ActorClient.start()`, `ActorClient.call()`, `TaskClient.start()`, `TaskClient.call()`, `TaskClient.update()`, and `TaskClient.update_input()`, among others. Check the API reference for the complete list.
-
-## Pluggable HTTP client architecture
-
-The HTTP layer is now abstracted behind `HttpClient` and `HttpClientAsync` base classes. The default implementation based on [Impit](https://github.com/apify/impit) (`ImpitHttpClient` / `ImpitHttpClientAsync`) is unchanged, but you can now replace it with your own.
-
-To use a custom HTTP client, implement the `call()` method and pass the instance via the `ApifyClient.with_custom_http_client()` class method:
-
-```python
-from apify_client import ApifyClient
-from apify_client.http_clients import HttpClient, HttpResponse
-
-class MyHttpClient(HttpClient):
- def call(self, *, method, url, headers=None, params=None,
- data=None, json=None, stream=None, timeout='medium') -> HttpResponse:
- ...
-
-client = ApifyClient.with_custom_http_client(
- token='MY-APIFY-TOKEN',
- http_client=MyHttpClient(),
-)
```
-The response must satisfy the `HttpResponse` protocol (properties: `status_code`, `text`, `content`, `headers`; sync methods: `json()`, `read()`, `close()`, `iter_bytes()`; async methods: `aread()`, `aclose()`, `aiter_bytes()`). Many popular libraries like `httpx` already satisfy this protocol out of the box.
-
-The HTTP base classes, the `HttpResponse` protocol, and the default `ImpitHttpClient` / `ImpitHttpClientAsync` implementations live in the `apify_client.http_clients` submodule. The `Timeout` alias used on the `call()` signature lives in `apify_client.types`.
-
-For a full walkthrough and working examples, see the [Custom HTTP clients](/docs/concepts/custom-http-clients) concept page and the [Custom HTTP client](/docs/guides/custom-http-client-httpx) guide.
-
-## Tiered timeout system
-
-Individual API methods now use a tiered timeout instead of a single global timeout. Each method declares a default tier appropriate for its expected latency.
-
-### Timeout tiers
-
-| Tier | Default | Typical use case |
-|---|---|---|
-| `short` | 5 s | Fast CRUD operations (get, update, delete) |
-| `medium` | 30 s | Batch and list operations, starting runs |
-| `long` | 360 s | Long-polling, streaming, data retrieval |
-| `no_timeout` | Disabled | Blocking calls like `actor.call()` that wait for a run to finish |
-
-A `timeout_max` value (default 360 s) caps the exponential growth of timeouts across retries.
+Two endpoints still return plain types because their payloads are user-defined: `DatasetClient.list_items()` returns `DatasetItemsPage` (with `items: list[dict[str, Any]]` following the [Actor output schema](https://docs.apify.com/platform/actors/development/actor-definition/output-schema)), and `KeyValueStoreClient.get_record()` returns a `dict`.
-### Configuring default tiers
+On the input side, methods now also accept Pydantic models in addition to dicts. Plain dicts continue to work — keys may use either snake_case or camelCase, and each input shape has a matching [`TypedDict`](https://docs.python.org/3/library/typing.html#typing.TypedDict) so editors and type checkers can validate the keys. See [Typed models](/docs/concepts/typed-models) for details.
-You can override the default duration of any tier on the `ApifyClient` constructor:
+## Tiered timeouts
-```python
-from datetime import timedelta
-
-from apify_client import ApifyClient
-
-client = ApifyClient(
- token='MY-APIFY-TOKEN',
- timeout_short=timedelta(seconds=10),
- timeout_medium=timedelta(seconds=60),
- timeout_long=timedelta(seconds=600),
- timeout_max=timedelta(seconds=600),
-)
-```
-
-### Per-call override
-
-Every resource client method exposes a `timeout` parameter. You can pass a tier name or a `timedelta` for a one-off override:
+The single global timeout has been replaced by four tiers — `short` (5 s), `medium` (30 s), `long` (360 s), and `no_timeout`. Each method picks an appropriate default. Override per call, or change tier defaults on the constructor:
```python
from datetime import timedelta
-# Use the 'long' tier for this specific call
-actor = client.actor('apify/hello-world').get(timeout='long')
+client = ApifyClient(token='MY-APIFY-TOKEN', timeout_short=timedelta(seconds=10))
-# Or pass an explicit duration
-actor = client.actor('apify/hello-world').get(timeout=timedelta(seconds=120))
+# Per-call override.
+client.actor('apify/hello-world').get(timeout='long')
+client.actor('apify/hello-world').get(timeout=timedelta(seconds=120))
```
-### Retry behavior
-
-On retries, the timeout doubles with each attempt (exponential backoff) up to `timeout_max`. For example, with `timeout_short=5s` and `timeout_max=360s`: attempt 1 uses 5 s, attempt 2 uses 10 s, attempt 3 uses 20 s, and so on.
+If your code relied on the previous global timeout, review the methods you use. See [Timeouts](/docs/concepts/timeouts) for the full reference.
-### Updated default timeout tiers
+## 404 raises NotFoundError on ambiguous endpoints
-The default timeout tier assigned to each method on non-storage resource clients has been revised to better match the expected latency of the underlying API endpoint. For example, a simple `get()` call now defaults to `short` (5 s), while `start()` defaults to `medium` (30 s) and `call()` defaults to `no_timeout`.
-
-If your code relied on the previous global timeout behavior, review the timeout tier on the methods you use and adjust via the `timeout` parameter or by overriding tier defaults on the `ApifyClient` constructor (see [Tiered timeout system](#tiered-timeout-system) above).
-
-## Exception subclasses for API errors
-
-The Apify client now provides dedicated error subclasses based on the HTTP status code of the failed response. Instantiating `ApifyApiError` directly still works — it returns the most specific subclass for the status — so existing `except ApifyApiError` handlers are unaffected. See the [Error handling](/docs/concepts/error-handling#error-subclasses) concept page for the full status-to-subclass mapping.
-
-You can now branch on error kind without inspecting `status_code` or `type`:
+Direct `.get(id)` and `.delete(id)` calls still swallow 404 into `None`. But where a 404 could mean either the parent or the sub-resource is missing, the client now raises `NotFoundError` instead of returning `None`.
```python
-from apify_client import ApifyClient
-from apify_client.errors import NotFoundError, RateLimitError
-
-client = ApifyClient(token='MY-APIFY-TOKEN')
-
-try:
- run = client.run('some-run-id').get()
-except NotFoundError:
- run = None
-except RateLimitError:
- ...
-```
-
-### Behavior change: 404 on ambiguous endpoints now raises `NotFoundError`
-
-Direct, ID-identified fetches like `client.dataset(id).get()` or `client.run(id).get()` continue to swallow 404 into `None` — a 404 there unambiguously means the named resource does not exist. Similarly, `.delete()` on an ID-identified client keeps its idempotent behavior (404 is silently swallowed).
-
-For calls where a 404 is *ambiguous*, the client now propagates `NotFoundError` instead of returning `None` / silently succeeding. Three categories of endpoints are affected:
-
-1. **Chained calls that target a default sub-resource without an ID** — `run.dataset()`, `run.key_value_store()`, `run.request_queue()`, `run.log()`. A 404 here could mean the parent run is missing OR the default sub-resource is missing, and the API body does not disambiguate. Applies to both `.get()` and `.delete()`.
-2. **`.get()` / `.get_as_bytes()` / `.stream()` on a chained `LogClient`** — e.g. `run.log().get()`. Direct `client.log(build_or_run_id).get()` still returns `None` on 404.
-3. **Singleton sub-resource endpoints fetched via a fixed path** — `ScheduleClient.get_log()`, `TaskClient.get_input()`, `DatasetClient.get_statistics()`, `UserClient.monthly_usage()`, `UserClient.limits()`, `WebhookClient.test()`. These hit paths like `/schedules/{id}/log` or `/actor-tasks/{id}/input`, so a 404 effectively means the parent is missing. Return types moved from `T | None` to `T`.
-
-```python
-from apify_client import ApifyClient
from apify_client.errors import NotFoundError
-client = ApifyClient(token='MY-APIFY-TOKEN')
+# Before — returned None on 404.
+dataset = client.run('some-run-id').dataset().get()
+# After — raises NotFoundError; handle it explicitly.
try:
dataset = client.run('some-run-id').dataset().get()
except NotFoundError:
- # Previously this returned `None`; now you must handle it explicitly.
dataset = None
-
-try:
- schedule_log = client.schedule('some-schedule-id').get_log()
-except NotFoundError:
- # `get_log()` previously returned `None` when the schedule was missing; now it raises.
- schedule_log = None
```
-Direct `.get()` also now swallows every 404 regardless of the `error.type` string in the response body (previously only `record-not-found` and `record-or-token-not-found` types were swallowed). If your code needs to distinguish between "resource missing" and "404 with an unexpected type", inspect `.type` on a caught `NotFoundError` from a non-`.get()` call path.
-
-## Keyword-only arguments for secondary parameters
-
-Several methods and utility functions had additional `*` separators inserted into their signatures, so optional/secondary parameters can no longer be passed positionally. The "subject" arguments (e.g. `key` on KVS record methods, `event_name` on `charge()`) remain positional; only the parameters that follow them are affected.
-
-### Affected APIs
-
-`KeyValueStoreClient` / `KeyValueStoreClientAsync`:
-
-- `get_record(key, *, signature=None, timeout='long')`
-- `get_record_as_bytes(key, *, signature=None, timeout='long')`
-- `stream_record(key, *, signature=None, timeout='long')`
-- `set_record(key, value, *, content_type=None, timeout='long')`
-
-`RunClient` / `RunClientAsync`:
+Affected paths:
-- `charge(event_name, *, count=1, idempotency_key=None, timeout='short')`
-- `get_status_message_watcher(*, to_logger=None, check_period=..., timeout='long')`
+- Chained calls that target a default sub-resource without an ID — `run.dataset()`, `run.key_value_store()`, `run.request_queue()`, `run.log()`.
+- Chained `LogClient` reads — `run.log().get()`, `.get_as_bytes()`, `.stream()`.
+- Singleton endpoints fetched via a fixed path — `ScheduleClient.get_log()`, `TaskClient.get_input()`, `DatasetClient.get_statistics()`, `UserClient.monthly_usage()`, `UserClient.limits()`, `WebhookClient.test()`. Their return types changed from `T | None` to `T`.
-`ApifyApiError` constructor:
+Status-specific subclasses such as `RateLimitError` are now available too — see [Error handling](/docs/concepts/error-handling#error-subclasses). Existing `except ApifyApiError` handlers are unaffected.
-- `ApifyApiError(response, attempt, *, method='GET')`
+## Keyword-only arguments
-### Migration
-
-Before (v2):
+Secondary parameters on these methods can no longer be passed positionally.
```python
+# Before
client.key_value_store('my-store').set_record('my-key', {'data': 1}, 'application/json')
client.run('my-run').charge('my-event', 5, 'my-idempotency-key')
-```
-After (v3):
-
-```python
+# After
client.key_value_store('my-store').set_record('my-key', {'data': 1}, content_type='application/json')
client.run('my-run').charge('my-event', count=5, idempotency_key='my-idempotency-key')
```
-## `Literal` type aliases instead of `StrEnum` classes
-
-Generated enum-like types are now [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal) type aliases instead of `StrEnum` classes. Pass plain strings instead of enum members; type checkers will validate them against the allowed set.
-
-Affected types: `ActorJobStatus`, `ActorPermissionLevel`, `ErrorType`, `GeneralAccess`, `HttpMethod`, `RunOrigin`, `SourceCodeFileFormat`, `StorageOwnership`, `VersionSourceType`, `WebhookDispatchStatus`, `WebhookEventType`.
-
-Before (v2):
-
-```python
-from apify_client._models import WebhookEventType
-
-client.actor('apify/hello-world').webhooks().create(
- event_types=[WebhookEventType.ACTOR_RUN_SUCCEEDED],
- request_url='https://example.com/webhook',
-)
-```
+Affected signatures:
-After (v3):
+- `KeyValueStoreClient` — `get_record`, `get_record_as_bytes`, `stream_record`, `set_record`.
+- `RunClient` — `charge`, `get_status_message_watcher`.
+- `ApifyApiError` constructor — `method` is keyword-only.
-```python
-client.actor('apify/hello-world').webhooks().create(
- event_types=['ACTOR.RUN.SUCCEEDED'],
- request_url='https://example.com/webhook',
-)
-```
+## Literal string aliases instead of StrEnum classes
-The aliases now live in `apify_client._literals` (previously `apify_client._models`) and can be imported for use in type annotations:
+Generated enum-like types are now [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal) string aliases instead of `StrEnum` classes. Pass plain strings instead of enum members; type checkers infer the allowed set directly from each method signature, so nothing needs to be imported for argument validation.
```python
-from apify_client._literals import WebhookEventType
+# Before
+event_types=[WebhookEventType.ACTOR_RUN_SUCCEEDED]
-events: list[WebhookEventType] = ['ACTOR.RUN.SUCCEEDED', 'ACTOR.RUN.FAILED']
+# After
+event_types=['ACTOR.RUN.SUCCEEDED']
```
-## Async `iterate_*` methods are plain functions, not async generators
-
-Async iteration helpers — `DatasetClientAsync.iterate_items()` and `KeyValueStoreClientAsync.iterate_keys()` — were previously declared as `async def` (async generator functions). They are now plain `def` functions that return an `AsyncIterator` produced by a shared pagination helper.
+Affected types: `ActorJobStatus`, `ActorPermissionLevel`, `ErrorType`, `GeneralAccess`, `HttpMethod`, `RunOrigin`, `SourceCodeFileFormat`, `StorageOwnership`, `VersionSourceType`, `WebhookDispatchStatus`, `WebhookEventType`. For more on the generated types and how they fit into the typed client surface, see [Typed models](/docs/concepts/typed-models).
-Consumer-side iteration is unchanged — `async for item in client.iterate_items(...)` works the same in both versions:
+## Async iterate_* are no longer coroutine functions
-```python
-# Works in both v2 and v3
-async for item in client.dataset('my-dataset').iterate_items():
- print(item)
-```
+`DatasetClientAsync.iterate_items()` and `KeyValueStoreClientAsync.iterate_keys()` are now plain `def` functions returning `AsyncIterator[T]`. Consumer code (`async for ...`) is unchanged. If you annotate the call's return value, change `AsyncGenerator[T, None]` to `AsyncIterator[T]`. For background on these helpers and how they fit alongside page models, see [Pagination](/docs/concepts/pagination).
-The difference matters only if your code inspects the function itself:
+## Removed deprecated APIs
-- The call is no longer a coroutine function — `inspect.iscoroutinefunction(client.iterate_items)` returns `False`, and `inspect.isasyncgenfunction(client.iterate_items)` also returns `False` (it returns a regular function whose result is an async iterator).
-- Type checkers see `def (...) -> AsyncIterator[T]` instead of `async def (...) -> AsyncIterator[T]`. Annotations on variables that hold the call's result may need to change from `AsyncGenerator[T, None]` to `AsyncIterator[T]`.
+- `DatasetClient.download_items()` → use `DatasetClient.get_items_as_bytes()` (identical signature).
+- `max_unprocessed_requests_retries` and `min_delay_between_unprocessed_requests_retries` on `RequestQueueClient.batch_add_requests()` — were no-ops; drop them.
+- `exclusive_start_id` on `RequestQueueClient.list_requests()` → use `cursor` with `next_cursor` from the previous response, or `iterate_requests()`.
-A new `RequestQueueClientAsync.iterate_requests()` helper is also introduced and follows the same `def ... -> AsyncIterator[T]` shape.
+## Pluggable HTTP client
-## Removal of deprecated APIs
-
-Methods and arguments that had been deprecated in v2 are removed in v3.
-
-### `DatasetClient.download_items()`
-
-The deprecated alias has been removed. Use `DatasetClient.get_items_as_bytes()` instead — the signature and behavior are identical.
-
-Before (v2):
-
-```python
-raw = client.dataset('my-dataset').download_items(item_format='csv')
-```
-
-After (v3):
-
-```python
-raw = client.dataset('my-dataset').get_items_as_bytes(item_format='csv')
-```
-
-### `batch_add_requests`: `max_unprocessed_requests_retries` and `min_delay_between_unprocessed_requests_retries`
-
-Both arguments have been removed from `RequestQueueClient.batch_add_requests()` and `RequestQueueClientAsync.batch_add_requests()`. They had no effect already in v2 — passing them only emitted a `DeprecationWarning`. Drop them from your call sites.
-
-Before (v2):
-
-```python
-rq_client.batch_add_requests(
- requests,
- max_unprocessed_requests_retries=3,
- min_delay_between_unprocessed_requests_retries=timedelta(seconds=1),
-)
-```
-
-After (v3):
-
-```python
-rq_client.batch_add_requests(requests)
-```
-
-### `list_requests`: `exclusive_start_id`
-
-The deprecated `exclusive_start_id` argument has been removed from `RequestQueueClient.list_requests()` and `RequestQueueClientAsync.list_requests()`. Use the `cursor` argument together with `next_cursor` from the previous response (or `iterate_requests()`, which handles pagination for you).
-
-Before (v2):
-
-```python
-page = rq_client.list_requests(limit=100)
-next_page = rq_client.list_requests(limit=100, exclusive_start_id=page.items[-1].id)
-```
-
-After (v3):
-
-```python
-page = rq_client.list_requests(limit=100)
-next_page = rq_client.list_requests(limit=100, cursor=page.next_cursor)
-```
+Additive change, non-breaking. The HTTP layer is now abstracted behind the `HttpClient` and `HttpClientAsync` base classes, so you can swap the underlying transport for your own implementation. The default client built on [Impit](https://github.com/apify/impit) is unchanged and existing code keeps working out of the box. To plug in a custom client, pass an instance to `ApifyClient.with_custom_http_client()` — see [Custom HTTP clients](/docs/concepts/custom-http-clients) for the full walkthrough.
diff --git a/pyproject.toml b/pyproject.toml
index 680ed8c7..c2d7fde4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project]
name = "apify_client"
-version = "2.5.1"
+version = "3.0.3"
description = "Apify API client for Python"
authors = [{ name = "Apify Technologies s.r.o.", email = "support@apify.com" }]
license = { file = "LICENSE" }
diff --git a/src/apify_client/_literals.py b/src/apify_client/_literals.py
index 28462a67..894a379d 100644
--- a/src/apify_client/_literals.py
+++ b/src/apify_client/_literals.py
@@ -149,6 +149,7 @@
'expired-conference-token',
'failed-to-charge-user',
'final-invoice-negative',
+ 'full-permission-actor-not-approved',
'github-branch-empty',
'github-issue-already-exists',
'github-public-key-not-found',
@@ -320,6 +321,7 @@
'requested-dataset-view-does-not-exist',
'resume-token-expired',
'run-failed',
+ 'run-input-body-not-valid-json',
'run-timeout-exceeded',
'russia-is-evil',
'same-user',
@@ -449,6 +451,7 @@
'WEBHOOK',
'ACTOR',
'CLI',
+ 'CI',
'STANDBY',
]
@@ -470,6 +473,7 @@
'GIT_REPO',
'TARBALL',
'GITHUB_GIST',
+ 'SOURCE_CODE',
]
diff --git a/src/apify_client/_models.py b/src/apify_client/_models.py
index a8a29fa5..19f5cf6d 100644
--- a/src/apify_client/_models.py
+++ b/src/apify_client/_models.py
@@ -32,6 +32,32 @@ class AccountLimits(BaseModel):
current: Current
+@docs_group('Models')
+class ActVersion(BaseModel):
+ """Snapshot of the Actor version that this build was created from."""
+
+ model_config = ConfigDict(
+ extra='allow',
+ populate_by_name=True,
+ )
+ source_type: Annotated[VersionSourceType | None, Field(alias='sourceType')] = None
+ build_tag: Annotated[str | None, Field(alias='buildTag', examples=['experimental'])] = None
+ version_number: Annotated[
+ str | None, Field(alias='versionNumber', examples=['0.0'], pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$')
+ ] = None
+ git_repo_url: Annotated[
+ str | None,
+ Field(alias='gitRepoUrl', examples=['https://github.com/apifytech/actor-crawler.git#experimental:web-scraper']),
+ ] = None
+ """
+ URL of the git repository, present when sourceType is GIT_REPO.
+ """
+ source_files: Annotated[list[SourceCodeFile] | None, Field(alias='sourceFiles')] = None
+ """
+ Inline source files, present when sourceType is SOURCE_FILES.
+ """
+
+
@docs_group('Models')
class Actor(BaseModel):
model_config = ConfigDict(
@@ -74,17 +100,62 @@ class Actor(BaseModel):
"""
A brief, LLM-generated readme summary
"""
+ seo_title: Annotated[str | None, Field(alias='seoTitle', examples=['Web Scraper'])] = None
+ seo_description: Annotated[
+ str | None,
+ Field(
+ alias='seoDescription',
+ examples=['Crawls websites using Chrome and extracts data from pages using JavaScript.'],
+ ),
+ ] = None
+ picture_url: Annotated[
+ str | None,
+ Field(alias='pictureUrl', examples=['https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png']),
+ ] = None
+ standby_url: Annotated[str | None, Field(alias='standbyUrl', examples=['https://my-actor.apify.actor'])] = None
+ notice: Annotated[str | None, Field(examples=['NONE'])] = None
+ categories: Annotated[list[str] | None, Field(examples=[['DEVELOPER_TOOLS', 'OPEN_SOURCE']])] = None
+ is_critical: Annotated[bool | None, Field(alias='isCritical', examples=[False])] = None
+ is_generic: Annotated[bool | None, Field(alias='isGeneric', examples=[False])] = None
+ is_source_code_hidden: Annotated[bool | None, Field(alias='isSourceCodeHidden', examples=[False])] = None
+ has_no_dataset: Annotated[bool | None, Field(alias='hasNoDataset', examples=[False])] = None
@docs_group('Models')
class ActorChargeEvent(BaseModel):
+ """Definition of a single chargeable event for a pay-per-event Actor. Each event is either flat-priced
+ (`eventPriceUsd` is set) or tier-priced (`eventTieredPricingUsd` is set); the two are mutually exclusive.
+
+ """
+
model_config = ConfigDict(
extra='allow',
populate_by_name=True,
)
- event_price_usd: Annotated[float, Field(alias='eventPriceUsd')]
event_title: Annotated[str, Field(alias='eventTitle')]
+ """
+ Human-readable title shown to users in the billing UI.
+ """
event_description: Annotated[str, Field(alias='eventDescription')]
+ """
+ Human-readable description of what triggers this event.
+ """
+ event_price_usd: Annotated[float | None, Field(alias='eventPriceUsd')] = None
+ """
+ Flat price per event in USD. Present only for non-tiered events. Mutually exclusive with `eventTieredPricingUsd`.
+
+ """
+ event_tiered_pricing_usd: Annotated[
+ dict[str, TieredPricingPerEventEntry] | None, Field(alias='eventTieredPricingUsd')
+ ] = None
+ is_primary_event: Annotated[bool | None, Field(alias='isPrimaryEvent')] = None
+ """
+ Whether this event is the Actor's primary chargeable event.
+ """
+ is_one_time_event: Annotated[bool | None, Field(alias='isOneTimeEvent')] = None
+ """
+ Whether this event can only be charged once per Actor run.
+ """
@docs_group('Models')
@@ -103,9 +174,9 @@ class ActorDefinition(BaseModel):
"""
The name of the Actor.
"""
- version: Annotated[str | None, Field(pattern='^[0-9]+\\.[0-9]+$')] = None
+ version: Annotated[str | None, Field(pattern='^[0-9]+(\\.[0-9]+)+$')] = None
"""
- The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0.
+ The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`).
"""
build_tag: Annotated[str | None, Field(alias='buildTag')] = None
"""
@@ -140,11 +211,11 @@ class ActorDefinition(BaseModel):
"""
Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory).
"""
- min_memory_mbytes: Annotated[int | None, Field(alias='minMemoryMbytes', ge=256)] = None
+ min_memory_mbytes: Annotated[int | None, Field(alias='minMemoryMbytes', ge=128)] = None
"""
Specifies the minimum amount of memory in megabytes required by the Actor.
"""
- max_memory_mbytes: Annotated[int | None, Field(alias='maxMemoryMbytes', ge=256)] = None
+ max_memory_mbytes: Annotated[int | None, Field(alias='maxMemoryMbytes', ge=128)] = None
"""
Specifies the maximum amount of memory in megabytes required by the Actor.
"""
@@ -230,6 +301,15 @@ class ActorStats(BaseModel):
last_run_started_at: Annotated[
AwareDatetime | None, Field(alias='lastRunStartedAt', examples=['2019-07-08T14:01:05.546Z'])
] = None
+ actor_review_count: Annotated[int | None, Field(alias='actorReviewCount', examples=[69])] = None
+ actor_review_rating: Annotated[float | None, Field(alias='actorReviewRating', examples=[4.7])] = None
+ bookmark_count: Annotated[int | None, Field(alias='bookmarkCount', examples=[1269])] = None
+ public_actor_run_stats30_days: Annotated[
+ PublicActorRunStats30Days | None, Field(alias='publicActorRunStats30Days')
+ ] = None
+ """
+ Run status counts over the past 30 days.
+ """
@docs_group('Models')
@@ -394,7 +474,18 @@ class Build(BaseModel):
str | None, Field(alias='inputSchema', deprecated=True, examples=['{\\n "title": "Schema for ... }'])
] = None
readme: Annotated[str | None, Field(deprecated=True, examples=['# Magic Actor\\nThis Actor is magic.'])] = None
- build_number: Annotated[str, Field(alias='buildNumber', examples=['0.1.1'])]
+ build_number: Annotated[
+ str,
+ Field(
+ alias='buildNumber',
+ examples=['0.1.1'],
+ pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$',
+ ),
+ ]
+ act_version: Annotated[ActVersion | None, Field(alias='actVersion', title='BuildActVersion')] = None
+ """
+ Snapshot of the Actor version that this build was created from.
+ """
actor_definition: Annotated[ActorDefinition | None, Field(alias='actorDefinition')] = None
@@ -429,12 +520,22 @@ class BuildShort(BaseModel):
)
id: Annotated[str, Field(examples=['HG7ML7M8z78YcAPEB'])]
act_id: Annotated[str | None, Field(alias='actId', examples=['janedoe~my-actor'])] = None
+ user_id: Annotated[str | None, Field(alias='userId', examples=['klmdEpoiojmdEMlk3'])] = None
status: ActorJobStatus
started_at: Annotated[AwareDatetime, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
finished_at: Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])] = (
None
)
usage_total_usd: Annotated[float, Field(alias='usageTotalUsd', examples=[0.02])]
+ build_number: Annotated[
+ str,
+ Field(
+ alias='buildNumber',
+ examples=['0.1.1'],
+ pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$',
+ ),
+ ]
+ build_number_int: Annotated[int | None, Field(alias='buildNumberInt', examples=[10000])] = None
meta: BuildsMeta | None = None
@@ -447,6 +548,7 @@ class BuildStats(BaseModel):
duration_millis: Annotated[int | None, Field(alias='durationMillis', examples=[1000])] = None
run_time_secs: Annotated[float | None, Field(alias='runTimeSecs', examples=[45.718])] = None
compute_units: Annotated[float, Field(alias='computeUnits', examples=[0.0126994444444444])]
+ image_size_bytes: Annotated[int | None, Field(alias='imageSizeBytes', examples=[975770223])] = None
@docs_group('Models')
@@ -530,6 +632,12 @@ class CommonActorPricingInfo(BaseModel):
notified_about_future_change_at: Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')] = None
notified_about_change_at: Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')] = None
reason_for_change: Annotated[str | None, Field(alias='reasonForChange')] = None
+ is_price_change_notification_suppressed: Annotated[
+ bool | None, Field(alias='isPriceChangeNotificationSuppressed')
+ ] = None
+ force_contains_significant_price_change: Annotated[
+ bool | None, Field(alias='forceContainsSignificantPriceChange')
+ ] = None
@docs_group('Models')
@@ -572,7 +680,9 @@ class CreateOrUpdateVersionRequest(BaseModel):
extra='allow',
populate_by_name=True,
)
- version_number: Annotated[str | None, Field(alias='versionNumber', examples=['0.0'])] = None
+ version_number: Annotated[
+ str | None, Field(alias='versionNumber', examples=['0.0'], pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$')
+ ] = None
source_type: Annotated[VersionSourceType | None, Field(alias='sourceType')] = None
env_vars: Annotated[list[EnvVarRequest] | None, Field(alias='envVars')] = None
apply_env_vars_to_build: Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])] = None
@@ -626,6 +736,7 @@ class Current(BaseModel):
actor_task_count: Annotated[int, Field(alias='actorTaskCount', examples=[130])]
active_actor_job_count: Annotated[int, Field(alias='activeActorJobCount', examples=[0])]
team_account_seat_count: Annotated[int, Field(alias='teamAccountSeatCount', examples=[5])]
+ schedule_count: Annotated[int | None, Field(alias='scheduleCount', examples=[77])] = None
@docs_group('Models')
@@ -635,6 +746,35 @@ class CurrentPricingInfo(BaseModel):
populate_by_name=True,
)
pricing_model: Annotated[str, Field(alias='pricingModel', examples=['FREE'])]
+ apify_margin_percentage: Annotated[float | None, Field(alias='apifyMarginPercentage', examples=[0.2])] = None
+ created_at: Annotated[AwareDatetime | None, Field(alias='createdAt', examples=['2023-01-01T00:00:00.000Z'])] = None
+ started_at: Annotated[AwareDatetime | None, Field(alias='startedAt', examples=['2023-01-01T00:00:00.000Z'])] = None
+ notified_about_change_at: Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt', examples=[None])] = (
+ None
+ )
+ notified_about_future_change_at: Annotated[
+ AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt', examples=[None])
+ ] = None
+ is_price_change_notification_suppressed: Annotated[
+ bool | None, Field(alias='isPriceChangeNotificationSuppressed', examples=[False])
+ ] = None
+ force_contains_significant_price_change: Annotated[
+ bool | None, Field(alias='forceContainsSignificantPriceChange', examples=[False])
+ ] = None
+ is_ppe_platform_usage_paid_by_user: Annotated[
+ bool | None, Field(alias='isPPEPlatformUsagePaidByUser', examples=[False])
+ ] = None
+ reason_for_change: Annotated[str | None, Field(alias='reasonForChange', examples=[None])] = None
+ trial_minutes: Annotated[int | None, Field(alias='trialMinutes', examples=[None])] = None
+ unit_name: Annotated[str | None, Field(alias='unitName', examples=[None])] = None
+ price_per_unit_usd: Annotated[float | None, Field(alias='pricePerUnitUsd', examples=[None])] = None
+ minimal_max_total_charge_usd: Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd', examples=[0.5])] = (
+ None
+ )
+ pricing_per_event: Annotated[dict[str, Any] | None, Field(alias='pricingPerEvent')] = None
+ """
+ Per-event pricing configuration for pay-per-event Actors.
+ """
@docs_group('Models')
@@ -751,6 +891,10 @@ class DatasetListItem(BaseModel):
clean_item_count: Annotated[int, Field(alias='cleanItemCount', examples=[5])]
act_id: Annotated[str | None, Field(alias='actId', examples=['zdc3Pyhyz3m8vjDeM'])] = None
act_run_id: Annotated[str | None, Field(alias='actRunId', examples=['HG7ML7M8z78YcAPEB'])] = None
+ title: Annotated[str | None, Field(examples=['My Dataset'])] = None
+ username: Annotated[str | None, Field(examples=['janedoe'])] = None
+ general_access: Annotated[GeneralAccess | None, Field(alias='generalAccess')] = None
+ stats: DatasetStats | None = None
@docs_group('Models')
@@ -808,9 +952,16 @@ class DatasetStats(BaseModel):
extra='allow',
populate_by_name=True,
)
- read_count: Annotated[int, Field(alias='readCount', examples=[22])]
- write_count: Annotated[int, Field(alias='writeCount', examples=[3])]
- storage_bytes: Annotated[int, Field(alias='storageBytes', examples=[783])]
+ read_count: Annotated[int | None, Field(alias='readCount', examples=[22])] = None
+ write_count: Annotated[int | None, Field(alias='writeCount', examples=[3])] = None
+ storage_bytes: Annotated[int | None, Field(alias='storageBytes', examples=[783])] = None
+ """
+ Total storage size in bytes. Only returned by the single-dataset endpoint.
+ """
+ inflated_bytes: Annotated[int | None, Field(alias='inflatedBytes', examples=[0])] = None
+ """
+ Uncompressed size in bytes. Only returned by the dataset list endpoint.
+ """
@docs_group('Models')
@@ -1049,6 +1200,7 @@ class ExampleWebhookDispatch(BaseModel):
finished_at: Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])] = (
None
)
+ removed_at: Annotated[AwareDatetime | None, Field(alias='removedAt', examples=[None])] = None
@docs_group('Models')
@@ -1171,6 +1323,19 @@ class KeyValueStore(BaseModel):
"""
A public link to access keys of the key-value store directly.
"""
+ records_public_url: Annotated[
+ AnyUrl | None,
+ Field(
+ alias='recordsPublicUrl', examples=['https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records']
+ ),
+ ] = None
+ """
+ A public link to access records of the key-value store directly.
+ """
+ schema_: Annotated[dict[str, Any] | None, Field(alias='schema')] = None
+ """
+ Optional JSON schema describing the keys stored in the key-value store.
+ """
url_signing_secret_key: Annotated[str | None, Field(alias='urlSigningSecretKey')] = None
"""
A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store.
@@ -1221,6 +1386,7 @@ class KeyValueStoreStats(BaseModel):
delete_count: Annotated[int, Field(alias='deleteCount', examples=[6])]
list_count: Annotated[int, Field(alias='listCount', examples=[2])]
s3_storage_bytes: Annotated[int | None, Field(alias='s3StorageBytes', examples=[18])] = None
+ storage_bytes: Annotated[int | None, Field(alias='storageBytes', examples=[457225])] = None
@docs_group('Models')
@@ -1258,6 +1424,7 @@ class Limits(BaseModel):
max_concurrent_actor_jobs: Annotated[int, Field(alias='maxConcurrentActorJobs', examples=[256])]
max_team_account_seat_count: Annotated[int, Field(alias='maxTeamAccountSeatCount', examples=[9])]
data_retention_days: Annotated[int, Field(alias='dataRetentionDays', examples=[90])]
+ max_schedule_count: Annotated[int | None, Field(alias='maxScheduleCount', examples=[100])] = None
@docs_group('Models')
@@ -1597,6 +1764,17 @@ class MonthlyUsageResponse(BaseModel):
data: MonthlyUsage
+@docs_group('Models')
+class Notifications(BaseModel):
+ """Notification settings for this schedule."""
+
+ model_config = ConfigDict(
+ extra='allow',
+ populate_by_name=True,
+ )
+ email: Annotated[bool | None, Field(examples=[True])] = None
+
+
@docs_group('Models')
class PaginationResponse(BaseModel):
"""Common pagination fields for list responses."""
@@ -1651,6 +1829,10 @@ class ListOfDatasets(PaginationResponse):
extra='allow',
populate_by_name=True,
)
+ unnamed: Annotated[bool | None, Field(examples=[False])] = None
+ """
+ Whether the listing was filtered to only unnamed datasets.
+ """
items: list[DatasetListItem]
@@ -1660,6 +1842,10 @@ class ListOfKeyValueStores(PaginationResponse):
extra='allow',
populate_by_name=True,
)
+ unnamed: Annotated[bool | None, Field(examples=[False])] = None
+ """
+ Whether the listing was filtered to only unnamed key-value stores.
+ """
items: list[KeyValueStore]
@@ -1671,6 +1857,10 @@ class ListOfRequestQueues(PaginationResponse):
extra='allow',
populate_by_name=True,
)
+ unnamed: Annotated[bool | None, Field(examples=[False])] = None
+ """
+ Whether the listing was filtered to only unnamed request queues.
+ """
items: list[RequestQueueShort]
"""
The array of request queues.
@@ -1780,6 +1970,14 @@ class Plan(BaseModel):
team_account_seat_count: Annotated[int, Field(alias='teamAccountSeatCount', examples=[1])]
support_level: Annotated[str, Field(alias='supportLevel', examples=['COMMUNITY'])]
available_add_ons: Annotated[list[str], Field(alias='availableAddOns', examples=[[]])]
+ tier: Annotated[str | None, Field(examples=['FREE'])] = None
+ api_rate_limit_boosts: Annotated[int | None, Field(alias='apiRateLimitBoosts', examples=[0])] = None
+ max_schedule_count: Annotated[int | None, Field(alias='maxScheduleCount', examples=[100])] = None
+ max_concurrent_actor_runs: Annotated[int | None, Field(alias='maxConcurrentActorRuns', examples=[25])] = None
+ plan_pricing: Annotated[dict[str, Any] | None, Field(alias='planPricing')] = None
+ """
+ Pricing details for this plan.
+ """
@docs_group('Models')
@@ -1793,7 +1991,13 @@ class PricePerDatasetItemActorPricingInfo(CommonActorPricingInfo):
"""
Name of the unit that is being charged
"""
- price_per_unit_usd: Annotated[float, Field(alias='pricePerUnitUsd')]
+ price_per_unit_usd: Annotated[float | None, Field(alias='pricePerUnitUsd')] = None
+ """
+ Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present
+ on a pricing record.
+
+ """
+ tiered_pricing: Annotated[dict[str, TieredPricingPerDatasetItemEntry] | None, Field(alias='tieredPricing')] = None
@docs_group('Models')
@@ -1871,10 +2075,25 @@ class ProxyGroup(BaseModel):
populate_by_name=True,
)
name: Annotated[str, Field(examples=['Group1'])]
- description: Annotated[str, Field(examples=['Group1 description'])]
+ description: Annotated[str | None, Field(examples=['Group1 description'])]
available_count: Annotated[int, Field(alias='availableCount', examples=[10])]
+@docs_group('Models')
+class PublicActorRunStats30Days(BaseModel):
+ """Run status counts over the past 30 days."""
+
+ model_config = ConfigDict(
+ extra='allow',
+ populate_by_name=True,
+ )
+ aborted: Annotated[int | None, Field(alias='ABORTED', examples=[2542])] = None
+ failed: Annotated[int | None, Field(alias='FAILED', examples=[1234])] = None
+ succeeded: Annotated[int | None, Field(alias='SUCCEEDED', examples=[732805])] = None
+ timed_out: Annotated[int | None, Field(alias='TIMED-OUT', examples=[12556])] = None
+ total: Annotated[int | None, Field(alias='TOTAL', examples=[749137])] = None
+
+
@docs_group('Models')
class PublicUserDataResponse(BaseModel):
model_config = ConfigDict(
@@ -2097,6 +2316,14 @@ class RequestQueue(BaseModel):
"""
The ID of the user who owns the request queue.
"""
+ act_id: Annotated[str | None, Field(alias='actId')] = None
+ """
+ The ID of the Actor that created this request queue.
+ """
+ act_run_id: Annotated[str | None, Field(alias='actRunId')] = None
+ """
+ The ID of the Actor run that created this request queue.
+ """
created_at: Annotated[AwareDatetime, Field(alias='createdAt', examples=['2019-12-12T07:34:14.202Z'])]
"""
The timestamp when the request queue was created.
@@ -2236,6 +2463,8 @@ class RequestQueueShort(BaseModel):
"""
Whether the request queue has been accessed by multiple different clients.
"""
+ general_access: Annotated[GeneralAccess | None, Field(alias='generalAccess')] = None
+ stats: RequestQueueStats | None = None
@docs_group('Models')
@@ -2429,7 +2658,14 @@ class Run(BaseModel):
"""
A map of aliased storage IDs associated with this run, grouped by storage type.
"""
- build_number: Annotated[str | None, Field(alias='buildNumber', examples=['0.0.36'])] = None
+ build_number: Annotated[
+ str | None,
+ Field(
+ alias='buildNumber',
+ examples=['0.0.36'],
+ pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$',
+ ),
+ ] = None
"""
Build number of the Actor build used for this run.
"""
@@ -2463,6 +2699,12 @@ class Run(BaseModel):
"""
List of metamorph events that occurred during the run.
"""
+ platform_usage_billing_model: Annotated[str | None, Field(alias='platformUsageBillingModel', examples=['USER'])] = (
+ None
+ )
+ """
+ Indicates which party covers platform usage costs for this run.
+ """
@docs_group('Models')
@@ -2533,6 +2775,7 @@ class RunShort(BaseModel):
)
id: Annotated[str, Field(examples=['HG7ML7M8z78YcAPEB'])]
act_id: Annotated[str, Field(alias='actId', examples=['HDSasDasz78YcAPEB'])]
+ user_id: Annotated[str | None, Field(alias='userId', examples=['7sT5jcggjjA9fNcxF'])] = None
actor_task_id: Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])] = None
status: ActorJobStatus
started_at: Annotated[AwareDatetime, Field(alias='startedAt', examples=['2019-11-30T07:34:24.202Z'])]
@@ -2540,7 +2783,15 @@ class RunShort(BaseModel):
None
)
build_id: Annotated[str, Field(alias='buildId', examples=['HG7ML7M8z78YcAPEB'])]
- build_number: Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])] = None
+ build_number: Annotated[
+ str | None,
+ Field(
+ alias='buildNumber',
+ examples=['0.0.2'],
+ pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$',
+ ),
+ ] = None
+ build_number_int: Annotated[int | None, Field(alias='buildNumberInt', examples=[10000])] = None
meta: RunMeta
usage_total_usd: Annotated[float, Field(alias='usageTotalUsd', examples=[0.2])]
default_key_value_store_id: Annotated[str, Field(alias='defaultKeyValueStoreId', examples=['sfAjeR4QmeJCQzTfe'])]
@@ -2723,6 +2974,10 @@ class Schedule(ScheduleBase):
)
description: Annotated[str | None, Field(examples=['Schedule of actor ...'])] = None
title: str | None = None
+ notifications: Annotated[Notifications | None, Field(title='ScheduleNotifications')] = None
+ """
+ Notification settings for this schedule.
+ """
actions: list[Annotated[ScheduleActionRunActor | ScheduleActionRunActorTask, Field(discriminator='type')]]
@@ -2903,10 +3158,14 @@ class StoreListActor(BaseModel):
url: Annotated[AnyUrl | None, Field(examples=['https://...'])] = None
stats: ActorStats
current_pricing_info: Annotated[CurrentPricingInfo, Field(alias='currentPricingInfo')]
- is_white_listed_for_agentic_payment: Annotated[bool | None, Field(alias='isWhiteListedForAgenticPayment')] = None
+ is_white_listed_for_agentic_payments: Annotated[bool | None, Field(alias='isWhiteListedForAgenticPayments')] = None
"""
Whether the Actor is whitelisted for agentic payment processing.
"""
+ actor_review_count: Annotated[int | None, Field(alias='actorReviewCount', examples=[69])] = None
+ actor_review_rating: Annotated[float | None, Field(alias='actorReviewRating', examples=[4.7])] = None
+ bookmark_count: Annotated[int | None, Field(alias='bookmarkCount', examples=[1269])] = None
+ badge: Annotated[str | None, Field(examples=[None])] = None
readme_summary: Annotated[str | None, Field(alias='readmeSummary')] = None
"""
A brief, LLM-generated readme summary
@@ -2925,10 +3184,21 @@ class TaggedBuildInfo(BaseModel):
"""
The ID of the build associated with this tag.
"""
- build_number: Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])] = None
+ build_number: Annotated[
+ str | None,
+ Field(
+ alias='buildNumber',
+ examples=['0.0.2'],
+ pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$',
+ ),
+ ] = None
"""
The build number/version string.
"""
+ build_number_int: Annotated[int | None, Field(alias='buildNumberInt', examples=[42])] = None
+ """
+ The build number encoded as a single integer.
+ """
finished_at: Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-06-10T11:15:49.286Z'])] = (
None
)
@@ -3034,23 +3304,30 @@ class TestWebhookResponse(BaseModel):
@docs_group('Models')
-class UnknownBuildTagError(BaseModel):
+class TieredPricingPerDatasetItemEntry(BaseModel):
+ """A single tier's price-per-dataset-item entry."""
+
model_config = ConfigDict(
extra='allow',
populate_by_name=True,
)
- error: UnknownBuildTagErrorDetail | None = None
+ tiered_price_per_unit_usd: Annotated[float, Field(alias='tieredPricePerUnitUsd')]
+ """
+ Price per unit in USD for this tier.
+ """
@docs_group('Models')
-class UnknownBuildTagErrorDetail(ErrorDetail):
+class TieredPricingPerEventEntry(BaseModel):
+ """A single tier's price-per-event entry."""
+
model_config = ConfigDict(
extra='allow',
populate_by_name=True,
)
- type: Annotated[Literal['unknown-build-tag'], Field(title='ErrorType')] = 'unknown-build-tag'
+ tiered_event_price_usd: Annotated[float, Field(alias='tieredEventPriceUsd')]
"""
- Machine-processable error type identifier.
+ Price per event in USD for this tier.
"""
@@ -3329,7 +3606,9 @@ class Version(BaseModel):
extra='allow',
populate_by_name=True,
)
- version_number: Annotated[str, Field(alias='versionNumber', examples=['0.0'])]
+ version_number: Annotated[
+ str, Field(alias='versionNumber', examples=['0.0'], pattern='^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$')
+ ]
source_type: Annotated[VersionSourceType | None, Field(alias='sourceType')]
env_vars: Annotated[list[EnvVar] | None, Field(alias='envVars')] = None
apply_env_vars_to_build: Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])] = None
@@ -3435,6 +3714,7 @@ class WebhookDispatch(BaseModel):
status: WebhookDispatchStatus
event_type: Annotated[WebhookEventType, Field(alias='eventType')]
event_data: Annotated[EventData | None, Field(alias='eventData', title='eventData')] = None
+ webhook: WebhookDispatchWebhookSummary | None = None
calls: Annotated[list[Call] | None, Field(title='calls')] = None
@@ -3443,6 +3723,20 @@ class WebhookDispatchResponse(TestWebhookResponse):
pass
+@docs_group('Models')
+class WebhookDispatchWebhookSummary(BaseModel):
+ """A summary of the webhook that triggered this dispatch."""
+
+ model_config = ConfigDict(
+ extra='allow',
+ populate_by_name=True,
+ )
+ action_type: Annotated[str | None, Field(alias='actionType', examples=['HTTP_REQUEST'])] = None
+ condition: WebhookCondition | None = None
+ request_url: Annotated[AnyUrl | None, Field(alias='requestUrl', examples=['https://example.com/webhook'])] = None
+ is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
+
+
@docs_group('Models')
class WebhookRepresentation(BaseModel):
"""Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the
@@ -3496,6 +3790,9 @@ class WebhookShort(BaseModel):
modified_at: Annotated[AwareDatetime, Field(alias='modifiedAt', examples=['2019-12-13T08:36:13.202Z'])]
user_id: Annotated[str, Field(alias='userId', examples=['wRsJZtadYvn4mBZmm'])]
is_ad_hoc: Annotated[bool | None, Field(alias='isAdHoc', examples=[False])] = None
+ is_apify_integration: Annotated[bool | None, Field(alias='isApifyIntegration', examples=[False])] = None
+ is_enabled: Annotated[bool | None, Field(alias='isEnabled', examples=[True])] = None
+ action_type: Annotated[str | None, Field(alias='actionType', examples=['HTTP_REQUEST'])] = None
should_interpolate_strings: Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])] = None
event_types: Annotated[list[WebhookEventType], Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']])]
condition: WebhookCondition
diff --git a/src/apify_client/_resource_clients/actor.py b/src/apify_client/_resource_clients/actor.py
index 150c7038..4afeb921 100644
--- a/src/apify_client/_resource_clients/actor.py
+++ b/src/apify_client/_resource_clients/actor.py
@@ -75,7 +75,7 @@ def __init__(
self,
*,
resource_id: str,
- resource_path: str = 'acts',
+ resource_path: str = 'actors',
**kwargs: Any,
) -> None:
super().__init__(
@@ -571,7 +571,7 @@ def __init__(
self,
*,
resource_id: str,
- resource_path: str = 'acts',
+ resource_path: str = 'actors',
**kwargs: Any,
) -> None:
super().__init__(
diff --git a/src/apify_client/_resource_clients/actor_collection.py b/src/apify_client/_resource_clients/actor_collection.py
index e63adbdf..892f4f58 100644
--- a/src/apify_client/_resource_clients/actor_collection.py
+++ b/src/apify_client/_resource_clients/actor_collection.py
@@ -36,7 +36,7 @@ class ActorCollectionClient(ResourceClient):
def __init__(
self,
*,
- resource_path: str = 'acts',
+ resource_path: str = 'actors',
**kwargs: Any,
) -> None:
super().__init__(
@@ -215,7 +215,7 @@ class ActorCollectionClientAsync(ResourceClientAsync):
def __init__(
self,
*,
- resource_path: str = 'acts',
+ resource_path: str = 'actors',
**kwargs: Any,
) -> None:
super().__init__(
diff --git a/src/apify_client/_streamed_log.py b/src/apify_client/_streamed_log.py
index f57ba074..92178e9a 100644
--- a/src/apify_client/_streamed_log.py
+++ b/src/apify_client/_streamed_log.py
@@ -5,9 +5,9 @@
import re
import threading
from asyncio import Task
-from datetime import UTC, datetime
+from datetime import UTC, datetime, timedelta
from threading import Thread
-from typing import TYPE_CHECKING, Self, cast
+from typing import TYPE_CHECKING, ClassVar, Self, cast
from apify_client._docs import docs_group
@@ -90,6 +90,10 @@ class StreamedLog(StreamedLogBase):
call `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`.
"""
+ # Caps how long `iter_bytes()` can block on a silent stream so `stop()` can unblock within
+ # this window instead of waiting for the long-polling default.
+ _read_timeout: ClassVar[timedelta] = timedelta(seconds=30)
+
def __init__(self, log_client: LogClient, *, to_logger: logging.Logger, from_start: bool = True) -> None:
"""Initialize `StreamedLog`.
@@ -138,17 +142,17 @@ def __exit__(
self.stop()
def _stream_log(self) -> None:
- with self._log_client.stream(raw=True) as log_stream:
+ with self._log_client.stream(raw=True, timeout=self._read_timeout) as log_stream:
if not log_stream:
return
- for data in log_stream.iter_bytes():
- self._process_new_data(data)
- if self._stop_logging:
- break
-
- # If the stream is finished, then the last part will be also processed.
- self._log_buffer_content(include_last_part=True)
- return
+ try:
+ for data in log_stream.iter_bytes():
+ self._process_new_data(data)
+ if self._stop_logging:
+ break
+ finally:
+ # Flush the last buffered part even if the read timed out or was stopped.
+ self._log_buffer_content(include_last_part=True)
@docs_group('Other')
@@ -214,8 +218,9 @@ async def _stream_log(self) -> None:
async with self._log_client.stream(raw=True) as log_stream:
if not log_stream:
return
- async for data in log_stream.aiter_bytes():
- self._process_new_data(data)
-
- # If the stream is finished, then the last part will be also processed.
- self._log_buffer_content(include_last_part=True)
+ try:
+ async for data in log_stream.aiter_bytes():
+ self._process_new_data(data)
+ finally:
+ # Flush the last buffered part even if the task is cancelled by `stop()`.
+ self._log_buffer_content(include_last_part=True)
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/_utils.py b/tests/_utils.py
new file mode 100644
index 00000000..e17c21ae
--- /dev/null
+++ b/tests/_utils.py
@@ -0,0 +1,237 @@
+from __future__ import annotations
+
+import asyncio
+import inspect
+import secrets
+import string
+import time
+from collections.abc import AsyncIterator, Iterator
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any, Protocol, TypeVar, cast, overload
+
+import pytest
+
+if TYPE_CHECKING:
+ from collections.abc import Awaitable, Callable
+
+# Environment variable names for test configuration
+TOKEN_ENV_VAR = 'APIFY_TEST_USER_API_TOKEN'
+TOKEN_ENV_VAR_2 = 'APIFY_TEST_USER_2_API_TOKEN'
+API_URL_ENV_VAR = 'APIFY_INTEGRATION_TESTS_API_URL'
+
+T = TypeVar('T')
+
+
+class _HasId(Protocol):
+ """Items returned by collection `iterate()` endpoints all expose `.id`."""
+
+ @property
+ def id(self) -> str: ...
+
+
+_HasIdT = TypeVar('_HasIdT', bound=_HasId)
+
+
+# ============================================================================
+# Data classes for test fixtures
+# ============================================================================
+
+
+@dataclass
+class StorageFixture:
+ """Base storage fixture with ID and signature."""
+
+ id: str
+ signature: str
+
+
+@dataclass
+class DatasetFixture(StorageFixture):
+ """Dataset fixture with expected content."""
+
+ expected_content: list
+
+
+@dataclass
+class KvsFixture(StorageFixture):
+ """Key-value store fixture with expected content and key signatures."""
+
+ expected_content: dict[str, Any]
+ keys_signature: dict[str, str]
+
+
+# ============================================================================
+# Helper functions
+# ============================================================================
+
+
+def get_crypto_random_object_id(length: int = 17) -> str:
+ """Generate a cryptographically secure random object ID."""
+ chars = 'abcdefghijklmnopqrstuvwxyzABCEDFGHIJKLMNOPQRSTUVWXYZ0123456789'
+ return ''.join(secrets.choice(chars) for _ in range(length))
+
+
+def get_random_string(length: int = 10) -> str:
+ """Generate a random alphabetic string."""
+ return ''.join(secrets.choice(string.ascii_letters) for _ in range(length))
+
+
+def get_random_resource_name(label: str) -> str:
+ """Generate a unique resource name containing the given label.
+
+ Ensures the generated name does not exceed the API limit of 63 characters.
+ """
+ name_template = 'python-client-test-{}-{}'
+ template_length = len(name_template.format('', ''))
+ api_name_limit = 63
+ random_id_length = 8
+ label_length_limit = api_name_limit - template_length - random_id_length
+
+ label = label.replace('_', '-')
+ assert len(label) <= label_length_limit, f'Max label length is {label_length_limit}, but got {len(label)}'
+
+ return name_template.format(label, get_crypto_random_object_id(random_id_length))
+
+
+async def maybe_await(value: Awaitable[T] | T) -> T:
+ """Await `value` if it is awaitable, otherwise return it unchanged.
+
+ Enables unified test code for both sync and async clients:
+ result = await maybe_await(client.datasets().list())
+ """
+ if inspect.isawaitable(value):
+ return await cast('Awaitable[T]', value)
+ return value
+
+
+async def maybe_sleep(seconds: float, *, is_async: bool) -> None:
+ """Sleep using asyncio or time.sleep based on client type."""
+ if is_async:
+ await asyncio.sleep(seconds)
+ else:
+ time.sleep(seconds) # noqa: ASYNC251
+
+
+@overload
+async def poll_until_condition(
+ fn: Callable[[], Awaitable[T]],
+ condition: Callable[[T], bool] = ...,
+ *,
+ timeout: float = ...,
+ poll_interval: float = ...,
+ backoff_factor: float = ...,
+) -> T: ...
+@overload
+async def poll_until_condition(
+ fn: Callable[[], T],
+ condition: Callable[[T], bool] = ...,
+ *,
+ timeout: float = ...,
+ poll_interval: float = ...,
+ backoff_factor: float = ...,
+) -> T: ...
+async def poll_until_condition(
+ fn: Callable[[], Awaitable[T] | T],
+ condition: Callable[[T], bool] = bool,
+ *,
+ timeout: float = 5,
+ poll_interval: float = 1,
+ backoff_factor: float = 1,
+) -> T:
+ """Poll `fn` until `condition(result)` is True or the timeout expires.
+
+ Polls `fn` at `poll_interval`-second intervals until `condition` is satisfied or `timeout` seconds have elapsed.
+ Returns the last polled result regardless of whether the condition was met, so the caller can run its own
+ assertion. The default condition checks for a truthy result.
+
+ Use this instead of a fixed `asyncio.sleep` when waiting for eventually-consistent state (e.g. a freshly
+ created resource appearing in a listing) that may take a variable amount of time to propagate. For highly
+ variable wait times (e.g. an Actor run container starting up), pass `backoff_factor` > 1 to multiply the
+ interval after each poll, covering a long timeout with few calls.
+ """
+ deadline = time.monotonic() + timeout
+ delay = poll_interval
+ result = await maybe_await(fn())
+ while not condition(result):
+ remaining = deadline - time.monotonic()
+ if remaining <= 0:
+ break
+ await asyncio.sleep(min(delay, remaining))
+ delay *= backoff_factor
+ result = await maybe_await(fn())
+ return result
+
+
+async def collect_iterate_until_present(
+ iterator_factory: Callable[[], Iterator[_HasIdT] | AsyncIterator[_HasIdT]],
+ expected_ids: set[str],
+ *,
+ item_type: type[_HasIdT],
+ is_async: bool,
+ max_attempts: int = 5,
+ interval: float = 1.0,
+) -> list[_HasIdT]:
+ """Drain a collection `iterate()` until every expected ID is present.
+
+ Handles eventual consistency on listing endpoints: under parallel load a freshly
+ created resource may not appear in the listing for a short window. Each attempt
+ builds a fresh iterator via `iterator_factory`, drains it, and stops early once
+ `expected_ids` is a subset of the collected items' `.id` values. The most recent
+ collection is returned regardless of whether the condition was met, so the caller
+ can run its own assertion with a helpful failure message.
+
+ Args:
+ iterator_factory: No-arg callable returning a fresh iterator on each call.
+ expected_ids: IDs that must all appear in the collected items.
+ item_type: Asserted to match the runtime type of each yielded item.
+ is_async: Whether the iterator is async (and so are sleeps).
+ max_attempts: Maximum number of polling rounds, guaranteed regardless of how long each drain takes.
+ interval: Seconds to sleep between attempts.
+
+ Returns:
+ The most recently collected items.
+ """
+
+ async def drain() -> list[_HasIdT]:
+ iterator = iterator_factory()
+ collected: list[_HasIdT] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for item in iterator:
+ assert isinstance(item, item_type)
+ collected.append(item)
+ else:
+ assert isinstance(iterator, Iterator)
+ for item in iterator:
+ assert isinstance(item, item_type)
+ collected.append(item)
+ return collected
+
+ # Loop on attempt count rather than a wall-clock deadline: drains take HTTP time, and charging it
+ # against a deadline would mean fewer retries under load — exactly when they are needed most.
+ collected = await drain()
+ for _ in range(max_attempts - 1):
+ if expected_ids.issubset(item.id for item in collected):
+ break
+ await maybe_sleep(interval, is_async=is_async)
+ collected = await drain()
+ return collected
+
+
+# ============================================================================
+# Pytest markers and parametrization
+# ============================================================================
+
+parametrized_api_urls = pytest.mark.parametrize(
+ ('api_url', 'api_public_url'),
+ [
+ ('https://api.apify.com', 'https://api.apify.com'),
+ ('https://api.apify.com', None),
+ ('https://api.apify.com', 'https://custom-public-url.com'),
+ ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path'),
+ ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path/'),
+ ('http://10.0.88.214:8010', 'https://api.apify.com'),
+ ('http://10.0.88.214:8010', None),
+ ],
+)
+"""Parametrize decorator for testing various API URL and public URL combinations."""
diff --git a/tests/integration/_utils.py b/tests/integration/_utils.py
deleted file mode 100644
index 8a3e1f1f..00000000
--- a/tests/integration/_utils.py
+++ /dev/null
@@ -1,127 +0,0 @@
-from __future__ import annotations
-
-import asyncio
-import secrets
-import string
-import time
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, TypeVar, overload
-
-import pytest
-
-if TYPE_CHECKING:
- from collections.abc import Coroutine
-
-# Environment variable names for test configuration
-TOKEN_ENV_VAR = 'APIFY_TEST_USER_API_TOKEN'
-TOKEN_ENV_VAR_2 = 'APIFY_TEST_USER_2_API_TOKEN'
-API_URL_ENV_VAR = 'APIFY_INTEGRATION_TESTS_API_URL'
-
-T = TypeVar('T')
-
-
-# ============================================================================
-# Data classes for test fixtures
-# ============================================================================
-
-
-@dataclass
-class StorageFixture:
- """Base storage fixture with ID and signature."""
-
- id: str
- signature: str
-
-
-@dataclass
-class DatasetFixture(StorageFixture):
- """Dataset fixture with expected content."""
-
- expected_content: list
-
-
-@dataclass
-class KvsFixture(StorageFixture):
- """Key-value store fixture with expected content and key signatures."""
-
- expected_content: dict[str, Any]
- keys_signature: dict[str, str]
-
-
-# ============================================================================
-# Helper functions
-# ============================================================================
-
-
-def get_crypto_random_object_id(length: int = 17) -> str:
- """Generate a cryptographically secure random object ID."""
- chars = 'abcdefghijklmnopqrstuvwxyzABCEDFGHIJKLMNOPQRSTUVWXYZ0123456789'
- return ''.join(secrets.choice(chars) for _ in range(length))
-
-
-def get_random_string(length: int = 10) -> str:
- """Generate a random alphabetic string."""
- return ''.join(secrets.choice(string.ascii_letters) for _ in range(length))
-
-
-def get_random_resource_name(label: str) -> str:
- """Generate a unique resource name containing the given label.
-
- Ensures the generated name does not exceed the API limit of 63 characters.
- """
- name_template = 'python-client-test-{}-{}'
- template_length = len(name_template.format('', ''))
- api_name_limit = 63
- random_id_length = 8
- label_length_limit = api_name_limit - template_length - random_id_length
-
- label = label.replace('_', '-')
- assert len(label) <= label_length_limit, f'Max label length is {label_length_limit}, but got {len(label)}'
-
- return name_template.format(label, get_crypto_random_object_id(random_id_length))
-
-
-@overload
-async def maybe_await(value: Coroutine[Any, Any, T]) -> T: ...
-
-
-@overload
-async def maybe_await(value: T) -> T: ...
-
-
-async def maybe_await(value: T | Coroutine[Any, Any, T]) -> T:
- """Await coroutines, pass through other values.
-
- Enables unified test code for both sync and async clients:
- result = await maybe_await(client.datasets().list())
- """
- if hasattr(value, '__await__'):
- return await value # ty: ignore[invalid-await]
- return value
-
-
-async def maybe_sleep(seconds: float, *, is_async: bool) -> None:
- """Sleep using asyncio or time.sleep based on client type."""
- if is_async:
- await asyncio.sleep(seconds)
- else:
- time.sleep(seconds) # noqa: ASYNC251
-
-
-# ============================================================================
-# Pytest markers and parametrization
-# ============================================================================
-
-parametrized_api_urls = pytest.mark.parametrize(
- ('api_url', 'api_public_url'),
- [
- ('https://api.apify.com', 'https://api.apify.com'),
- ('https://api.apify.com', None),
- ('https://api.apify.com', 'https://custom-public-url.com'),
- ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path'),
- ('https://api.apify.com', 'https://custom-public-url.com/with/custom/path/'),
- ('http://10.0.88.214:8010', 'https://api.apify.com'),
- ('http://10.0.88.214:8010', None),
- ],
-)
-"""Parametrize decorator for testing various API URL and public URL combinations."""
diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
index f6bd2053..1cdb3689 100644
--- a/tests/integration/conftest.py
+++ b/tests/integration/conftest.py
@@ -6,7 +6,7 @@
import pytest
-from ._utils import (
+from .._utils import (
API_URL_ENV_VAR,
TOKEN_ENV_VAR,
TOKEN_ENV_VAR_2,
diff --git a/tests/integration/test_actor.py b/tests/integration/test_actor.py
index f9751d70..ab271334 100644
--- a/tests/integration/test_actor.py
+++ b/tests/integration/test_actor.py
@@ -2,16 +2,32 @@
from __future__ import annotations
-from datetime import UTC, datetime
+from collections.abc import AsyncIterator, Iterator
+from datetime import UTC, datetime, timedelta
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
-from apify_client._models import Actor, Build, ListOfActors, Run
+from .._utils import get_random_resource_name, maybe_await
+from apify_client._models import (
+ Actor,
+ ActorChargeEvent,
+ ActorShort,
+ Build,
+ ListOfActors,
+ ListOfWebhooks,
+ PayPerEventActorPricingInfo,
+ PricePerDatasetItemActorPricingInfo,
+ Run,
+)
from apify_client._resource_clients import BuildClient, BuildClientAsync
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
+# Actor carrying pricing-info entries for every non-trivial variant: FLAT_PRICE_PER_MONTH,
+# both flat and tiered PRICE_PER_DATASET_ITEM, and tiered PAY_PER_EVENT with
+# `isPrimaryEvent` / `isOneTimeEvent` fields.
+ALL_PRICING_VARIANTS_ACTOR = 'apify/facebook-pages-scraper'
+
async def test_get_public_actor(client: ApifyClient | ApifyClientAsync) -> None:
"""Test getting a public Actor by ID."""
@@ -172,3 +188,243 @@ async def test_actor_validate_input(client: ApifyClient | ApifyClientAsync) -> N
# Valid input (hello-world accepts empty input or simple input)
is_valid = await maybe_await(actor_client.validate_input({}))
assert is_valid is True
+
+
+async def test_get_nonexistent_actor_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that getting a non-existent Actor returns None."""
+ actor = await maybe_await(client.actor('this-actor/does-not-exist-anywhere').get())
+ assert actor is None
+
+
+async def test_list_actors_desc_ascending(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing Actors sorted ascending (desc=False)."""
+ actors_page = await maybe_await(client.actors().list(limit=10, desc=False, sort_by='stats.lastRunStartedAt'))
+ assert isinstance(actors_page, ListOfActors)
+ assert actors_page.items is not None
+
+ # The API and Python may break ties on identical timestamps differently, so just verify the
+ # sort key is monotonically non-decreasing rather than comparing to a locally re-sorted list.
+ min_dt = datetime.min.replace(tzinfo=UTC)
+ keys = [(a.stats.last_run_started_at if a.stats else None) or min_dt for a in actors_page.items]
+ assert keys == sorted(keys)
+
+
+async def test_actors_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user's Actors."""
+ iterator = client.actors().iterate(my=True, limit=10)
+ collected: list[ActorShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for a in iterator:
+ assert isinstance(a, ActorShort)
+ collected.append(a)
+ else:
+ assert isinstance(iterator, Iterator)
+ for a in iterator:
+ assert isinstance(a, ActorShort)
+ collected.append(a)
+
+ assert len(collected) <= 10
+ for actor in collected:
+ assert actor.id is not None
+
+
+async def test_actor_start_with_options(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test starting an Actor with explicit run options."""
+ actor_client = client.actor('apify/hello-world')
+
+ # Start the run with explicit build tag, memory, and timeout overrides
+ run = await maybe_await(
+ actor_client.start(
+ build='latest',
+ memory_mbytes=256,
+ run_timeout=timedelta(seconds=120),
+ wait_for_finish=60,
+ )
+ )
+ assert isinstance(run, Run)
+ assert run.id is not None
+ assert run.options is not None
+ assert run.options.memory_mbytes == 256
+ assert run.options.timeout_secs == 120
+
+ try:
+ # Any terminal-or-in-progress status returned by the platform is acceptable here —
+ # under load the run can briefly land in `TIMING-OUT`, `FAILED`, `ABORTING`, or `ABORTED`
+ # without indicating a client-side bug.
+ assert run.status in (
+ 'READY',
+ 'RUNNING',
+ 'SUCCEEDED',
+ 'TIMED-OUT',
+ 'TIMING-OUT',
+ 'FAILED',
+ 'ABORTING',
+ 'ABORTED',
+ )
+ finally:
+ # Wait for run to finish before cleanup
+ await maybe_await(client.run(run.id).wait_for_finish())
+ await maybe_await(client.run(run.id).delete())
+
+
+async def test_actor_start_with_run_input(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test starting an Actor with a JSON run input."""
+ actor_client = client.actor('apify/hello-world')
+
+ # Pass a custom input - hello-world accepts arbitrary input and echoes it in logs
+ run = await maybe_await(actor_client.start(run_input={'message': 'integration-test-input'}))
+ assert isinstance(run, Run)
+ assert run.id is not None
+
+ run_client = client.run(run.id)
+ try:
+ finished_run = await maybe_await(run_client.wait_for_finish())
+ assert isinstance(finished_run, Run)
+ assert finished_run.status == 'SUCCEEDED'
+ finally:
+ await maybe_await(run_client.delete())
+
+
+async def test_actor_call_with_input_and_build(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test calling an Actor with input and a specific build tag."""
+ actor_client = client.actor('apify/hello-world')
+
+ run = await maybe_await(
+ actor_client.call(
+ run_input={'message': 'integration-test'},
+ build='latest',
+ memory_mbytes=256,
+ )
+ )
+ assert isinstance(run, Run)
+
+ try:
+ assert run.status == 'SUCCEEDED'
+ finally:
+ await maybe_await(client.run(run.id).delete())
+
+
+async def test_actor_update_categories(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test updating an Actor's categories and seo_title fields."""
+ actor_name = get_random_resource_name('actor')
+
+ created_actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ title='Test Actor for Categories',
+ )
+ )
+ assert isinstance(created_actor, Actor)
+ actor_client = client.actor(created_actor.id)
+
+ try:
+ updated = await maybe_await(
+ actor_client.update(
+ categories=['MARKETING'],
+ seo_title='SEO Test Title',
+ seo_description='SEO Test Description',
+ )
+ )
+ assert isinstance(updated, Actor)
+ # `categories` and `seo_title` are not declared fields on the Actor model but are returned via
+ # `extra='allow'` so we read them from the dumped representation.
+ dumped = updated.model_dump(by_alias=True)
+ assert dumped.get('categories') == ['MARKETING']
+ assert dumped.get('seoTitle') == 'SEO Test Title'
+ finally:
+ await maybe_await(actor_client.delete())
+
+
+async def test_actor_webhooks(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing webhooks attached to an Actor."""
+ actor_name = get_random_resource_name('actor')
+
+ created_actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ title='Test Actor for Webhooks',
+ )
+ )
+ assert isinstance(created_actor, Actor)
+ actor_client = client.actor(created_actor.id)
+
+ try:
+ webhooks_page = await maybe_await(actor_client.webhooks().list())
+ assert isinstance(webhooks_page, ListOfWebhooks)
+ # A fresh Actor has no webhooks attached.
+ assert webhooks_page.items == []
+ finally:
+ await maybe_await(actor_client.delete())
+
+
+async def test_actor_default_build_wait_for_finish(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test default_build with explicit wait_for_finish parameter."""
+ actor_client = client.actor('apify/hello-world')
+
+ build_client = await maybe_await(actor_client.default_build(wait_for_finish=1))
+ assert isinstance(build_client, BuildClient | BuildClientAsync)
+ build = await maybe_await(build_client.get())
+ assert isinstance(build, Build)
+
+
+async def test_actor_get_parses_tiered_price_per_dataset_item(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that actor.get() parses PRICE_PER_DATASET_ITEM entries with tieredPricing."""
+ actor = await maybe_await(client.actor(ALL_PRICING_VARIANTS_ACTOR).get())
+ assert isinstance(actor, Actor)
+ assert actor.pricing_infos
+
+ tiered_ppd_entries = [
+ info
+ for info in actor.pricing_infos
+ if isinstance(info, PricePerDatasetItemActorPricingInfo) and info.tiered_pricing is not None
+ ]
+ assert tiered_ppd_entries, (
+ f'{ALL_PRICING_VARIANTS_ACTOR} should have at least one tiered PRICE_PER_DATASET_ITEM entry — '
+ 'pick a different actor if pricing changed.'
+ )
+
+ # Fixture-drift guard: tiered pricing is only meaningful when it has more than one tier
+ # and the tiers actually differ in price. A degenerate single-tier or all-zero payload
+ # would silently look like flat pricing.
+ for entry in tiered_ppd_entries:
+ assert entry.tiered_pricing is not None
+ assert len(entry.tiered_pricing) >= 2, (
+ f'{ALL_PRICING_VARIANTS_ACTOR} tiered PPD entry has only {len(entry.tiered_pricing)} tier(s); '
+ 'expected multiple tiers (e.g. FREE/BRONZE/SILVER/GOLD/PLATINUM/DIAMOND).'
+ )
+ distinct_prices = {t.tiered_price_per_unit_usd for t in entry.tiered_pricing.values()}
+ assert len(distinct_prices) >= 2, (
+ f'{ALL_PRICING_VARIANTS_ACTOR} tiered PPD entry has all-identical prices ({distinct_prices}); '
+ 'tiers should differ.'
+ )
+
+
+async def test_actor_get_parses_tiered_pay_per_event(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that actor.get() parses tiered PAY_PER_EVENT events with isPrimaryEvent and isOneTimeEvent flags."""
+ actor = await maybe_await(client.actor(ALL_PRICING_VARIANTS_ACTOR).get())
+ assert isinstance(actor, Actor)
+ assert actor.pricing_infos
+
+ tiered_ppe_events: list[ActorChargeEvent] = []
+ for info in actor.pricing_infos:
+ if not isinstance(info, PayPerEventActorPricingInfo):
+ continue
+ events = info.pricing_per_event.actor_charge_events or {}
+ tiered_ppe_events.extend(event for event in events.values() if event.event_tiered_pricing_usd is not None)
+
+ assert tiered_ppe_events, (
+ f'{ALL_PRICING_VARIANTS_ACTOR} should have at least one tiered PAY_PER_EVENT event — '
+ 'pick a different actor if pricing changed.'
+ )
+ # Because every model uses `extra='allow'`, a regenerator that drops either alias would
+ # silently absorb the JSON key into `model_extra`. Asserting the typed attribute is
+ # populated catches that drift.
+ assert any(event.is_primary_event is True for event in tiered_ppe_events), (
+ f'{ALL_PRICING_VARIANTS_ACTOR}: no tiered PPE event has is_primary_event == True. '
+ 'The isPrimaryEvent alias may have been dropped from the model.'
+ )
+ assert any(event.is_one_time_event is not None for event in tiered_ppe_events), (
+ f'{ALL_PRICING_VARIANTS_ACTOR}: no tiered PPE event has is_one_time_event populated. '
+ 'The isOneTimeEvent alias may have been dropped from the model.'
+ )
diff --git a/tests/integration/test_actor_env_var.py b/tests/integration/test_actor_env_var.py
index 26c0cbd2..bd9cb6c9 100644
--- a/tests/integration/test_actor_env_var.py
+++ b/tests/integration/test_actor_env_var.py
@@ -2,9 +2,10 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
+from .._utils import get_random_resource_name, maybe_await
from apify_client._models import Actor, EnvVar, ListOfEnvVars
if TYPE_CHECKING:
@@ -228,3 +229,118 @@ async def test_actor_env_var_delete(client: ApifyClient | ApifyClientAsync) -> N
finally:
await maybe_await(actor_client.delete())
+
+
+async def test_actor_env_var_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterating over a version's environment variables."""
+ actor_name = get_random_resource_name('actor')
+
+ actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ versions=[
+ {
+ 'versionNumber': '0.0',
+ 'sourceType': 'SOURCE_FILES',
+ 'buildTag': 'latest',
+ 'sourceFiles': [{'name': 'main.js', 'format': 'TEXT', 'content': 'console.log("Hello")'}],
+ 'envVars': [{'name': f'VAR_{i}', 'value': f'value_{i}', 'isSecret': False} for i in range(3)],
+ }
+ ],
+ )
+ )
+ assert isinstance(actor, Actor)
+ actor_client = client.actor(actor.id)
+ version_client = actor_client.version('0.0')
+
+ try:
+ iterator = version_client.env_vars().iterate()
+ collected: list[EnvVar] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for e in iterator:
+ assert isinstance(e, EnvVar)
+ collected.append(e)
+ else:
+ assert isinstance(iterator, Iterator)
+ for e in iterator:
+ assert isinstance(e, EnvVar)
+ collected.append(e)
+
+ assert len(collected) == 3
+ names = {e.name for e in collected}
+ assert names == {'VAR_0', 'VAR_1', 'VAR_2'}
+ finally:
+ await maybe_await(actor_client.delete())
+
+
+async def test_actor_env_var_secret(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that creating a secret env var hides its plaintext value on retrieval."""
+ actor_name = get_random_resource_name('actor')
+
+ actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ versions=[
+ {
+ 'versionNumber': '0.0',
+ 'sourceType': 'SOURCE_FILES',
+ 'buildTag': 'latest',
+ 'sourceFiles': [{'name': 'main.js', 'format': 'TEXT', 'content': 'console.log("Hello")'}],
+ }
+ ],
+ )
+ )
+ assert isinstance(actor, Actor)
+ actor_client = client.actor(actor.id)
+ version_client = actor_client.version('0.0')
+
+ try:
+ created = await maybe_await(
+ version_client.env_vars().create(
+ name='MY_SECRET',
+ value='super-secret-token',
+ is_secret=True,
+ )
+ )
+ assert isinstance(created, EnvVar)
+ assert created.name == 'MY_SECRET'
+ assert created.is_secret is True
+
+ # When retrieved, secret values must not be exposed back to the API client
+ retrieved = await maybe_await(version_client.env_var('MY_SECRET').get())
+ assert isinstance(retrieved, EnvVar)
+ assert retrieved.is_secret is True
+ assert retrieved.value is None
+ finally:
+ await maybe_await(actor_client.delete())
+
+
+async def test_actor_env_var_get_nonexistent_returns_none(
+ client: ApifyClient | ApifyClientAsync,
+) -> None:
+ """Test that get() on a non-existent env var returns None."""
+ actor_name = get_random_resource_name('actor')
+
+ actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ versions=[
+ {
+ 'versionNumber': '0.0',
+ 'sourceType': 'SOURCE_FILES',
+ 'buildTag': 'latest',
+ 'sourceFiles': [{'name': 'main.js', 'format': 'TEXT', 'content': 'console.log("Hello")'}],
+ }
+ ],
+ )
+ )
+ assert isinstance(actor, Actor)
+ actor_client = client.actor(actor.id)
+ version_client = actor_client.version('0.0')
+
+ try:
+ env_var = await maybe_await(version_client.env_var('THIS_DOES_NOT_EXIST').get())
+ assert env_var is None
+ finally:
+ await maybe_await(actor_client.delete())
diff --git a/tests/integration/test_actor_version.py b/tests/integration/test_actor_version.py
index 6b59f447..ed3a1bb5 100644
--- a/tests/integration/test_actor_version.py
+++ b/tests/integration/test_actor_version.py
@@ -2,9 +2,10 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
+from .._utils import get_random_resource_name, maybe_await
from apify_client._models import Actor, ListOfVersions, Version
if TYPE_CHECKING:
@@ -205,3 +206,69 @@ async def test_actor_version_delete(client: ApifyClient | ApifyClientAsync) -> N
finally:
await maybe_await(actor_client.delete())
+
+
+async def test_actor_version_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterating over an Actor's versions (single-page endpoint)."""
+ actor_name = get_random_resource_name('actor')
+
+ actor = await maybe_await(
+ client.actors().create(
+ name=actor_name,
+ versions=[
+ {
+ 'versionNumber': f'0.{i}',
+ 'sourceType': 'SOURCE_FILES',
+ 'buildTag': 'latest' if i == 0 else f'v{i}',
+ 'sourceFiles': [
+ {
+ 'name': 'main.js',
+ 'format': 'TEXT',
+ 'content': f'console.log({i})',
+ }
+ ],
+ }
+ for i in range(3)
+ ],
+ )
+ )
+ assert isinstance(actor, Actor)
+ actor_client = client.actor(actor.id)
+
+ try:
+ iterator = actor_client.versions().iterate()
+ collected: list[Version] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for v in iterator:
+ assert isinstance(v, Version)
+ collected.append(v)
+ else:
+ assert isinstance(iterator, Iterator)
+ for v in iterator:
+ assert isinstance(v, Version)
+ collected.append(v)
+
+ # All three versions should be present
+ assert len(collected) == 3
+ version_numbers = {v.version_number for v in collected}
+ assert version_numbers == {'0.0', '0.1', '0.2'}
+ finally:
+ await maybe_await(actor_client.delete())
+
+
+async def test_actor_version_get_nonexistent_returns_none(
+ client: ApifyClient | ApifyClientAsync,
+) -> None:
+ """Test that get() on a non-existent version returns None."""
+ actor_name = get_random_resource_name('actor')
+
+ actor = await maybe_await(client.actors().create(name=actor_name))
+ assert isinstance(actor, Actor)
+ actor_client = client.actor(actor.id)
+
+ try:
+ version = await maybe_await(actor_client.version('99.99').get())
+ assert version is None
+ finally:
+ await maybe_await(actor_client.delete())
diff --git a/tests/integration/test_apify_client.py b/tests/integration/test_apify_client.py
index 5ec8e940..126f40b3 100644
--- a/tests/integration/test_apify_client.py
+++ b/tests/integration/test_apify_client.py
@@ -4,7 +4,7 @@
from typing import TYPE_CHECKING
-from ._utils import maybe_await
+from .._utils import maybe_await
from apify_client._models import UserPrivateInfo, UserPublicInfo
if TYPE_CHECKING:
diff --git a/tests/integration/test_build.py b/tests/integration/test_build.py
index 391a6cf6..2f1bd1ce 100644
--- a/tests/integration/test_build.py
+++ b/tests/integration/test_build.py
@@ -2,11 +2,12 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from datetime import timedelta
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
-from apify_client._models import Actor, Build, ListOfBuilds
+from .._utils import get_random_resource_name, maybe_await
+from apify_client._models import Actor, Build, BuildShort, ListOfBuilds
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
@@ -14,6 +15,34 @@
# Use a public actor that has builds available
HELLO_WORLD_ACTOR = 'apify/hello-world'
+# Apify-owned actor whose `latest` build sets `minMemoryMbytes: 128` (well below the spec's
+# previously-required minimum of 256). Also publishes `actorDefinition.version: "0.0.1"`,
+# exercising the semver-triplet version pattern.
+SMALL_MIN_MEMORY_ACTOR = 'apify/instagram-profile-scraper'
+
+# Apify-owned actor whose builds list includes entries with `meta.origin: "CI"`
+# from the internal CI pipeline. A deep `desc=True` pagination is needed because
+# CI builds are infrequent and rotate out of the most-recent window.
+CI_ORIGIN_ACTOR = 'apify/cheerio-scraper'
+
+
+def _pick_build_id(actor: Actor) -> str:
+ """Return a stable `build_id` from `actor.tagged_builds`, preferring the `latest` tag.
+
+ Avoids relying on API-side dict ordering (`next(iter(...))` would otherwise pick
+ whichever tag the API decides to serialize first).
+ """
+ assert actor.tagged_builds, f'{actor.username}/{actor.name} has no tagged builds'
+ latest = actor.tagged_builds.get('latest')
+ if latest is not None and latest.build_id is not None:
+ return latest.build_id
+ fallback = next(
+ (info.build_id for info in actor.tagged_builds.values() if info and info.build_id),
+ None,
+ )
+ assert fallback is not None, f'{actor.username}/{actor.name} has no tagged build with a build_id'
+ return fallback
+
async def test_build_list_for_actor(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing builds for a public Actor."""
@@ -188,6 +217,61 @@ async def test_build_delete_and_abort(client: ApifyClient | ApifyClientAsync) ->
await maybe_await(actor_client.delete())
+async def test_build_get_accepts_small_min_memory_mbytes(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that build.get() parses actorDefinition.minMemoryMbytes values below 256 MB."""
+ actor = await maybe_await(client.actor(SMALL_MIN_MEMORY_ACTOR).get())
+ assert isinstance(actor, Actor)
+ build_id = _pick_build_id(actor)
+
+ build = await maybe_await(client.build(build_id).get())
+ assert isinstance(build, Build)
+ assert build.actor_definition is not None, 'expected actorDefinition on a SUCCEEDED build'
+
+ # Fixture-drift guard: only meaningful if the chosen build actually carries a value
+ # below the old 256 threshold.
+ actual_min = build.actor_definition.min_memory_mbytes
+ assert actual_min is not None
+ assert actual_min < 256, (
+ f'{SMALL_MIN_MEMORY_ACTOR} latest build has min_memory_mbytes={actual_min!r} '
+ '(expected <256). Pick a different fixture to keep this test meaningful.'
+ )
+
+
+async def test_actor_builds_list_accepts_ci_origin(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that actor.builds().list() parses builds with meta.origin == 'CI'."""
+ builds = await maybe_await(client.actor(CI_ORIGIN_ACTOR).builds().list(limit=100, desc=True))
+ assert isinstance(builds, ListOfBuilds)
+ assert builds.items, f'{CI_ORIGIN_ACTOR} should have builds'
+
+ # Fixture-drift guard: only meaningful if the page actually contains a CI-origin build.
+ # Pydantic already validated every `meta.origin` against `RunOrigin` at deserialization,
+ # so the check is exercised iff at least one such entry exists.
+ ci_origin_builds = [b for b in builds.items if b.meta is not None and b.meta.origin == 'CI']
+ assert ci_origin_builds, (
+ f'{CI_ORIGIN_ACTOR}: no builds with meta.origin == "CI" in the most-recent 100. '
+ 'CI builds may have rotated out of the window — pick a different actor or paginate deeper.'
+ )
+
+
+async def test_actor_definition_version_accepts_semver_triplet(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that ActorDefinition.version accepts semver-triplet strings like '0.0.1'."""
+ actor = await maybe_await(client.actor(SMALL_MIN_MEMORY_ACTOR).get())
+ assert isinstance(actor, Actor)
+ build_id = _pick_build_id(actor)
+
+ build = await maybe_await(client.build(build_id).get())
+ assert isinstance(build, Build)
+ assert build.actor_definition is not None
+ # Fixture-drift guard: only meaningful if the chosen build's version actually carries
+ # more than one dot.
+ version = build.actor_definition.version
+ assert version is not None
+ assert version.count('.') >= 2, (
+ f'{SMALL_MIN_MEMORY_ACTOR} no longer publishes a multi-dot version (got {version!r}) — '
+ 'pick a different fixture to keep this test meaningful.'
+ )
+
+
async def test_build_get_open_api_definition(client: ApifyClient | ApifyClientAsync) -> None:
"""Test getting OpenAPI definition for a build."""
# Get builds for hello-world actor
@@ -204,3 +288,50 @@ async def test_build_get_open_api_definition(client: ApifyClient | ApifyClientAs
# OpenAPI definition should be a dict with standard OpenAPI fields
# Note: May be None if the actor doesn't have an OpenAPI definition
assert isinstance(openapi_def, dict)
+
+
+async def test_builds_iterate_for_actor(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over an Actor's builds."""
+ iterator = client.actor(HELLO_WORLD_ACTOR).builds().iterate(limit=5)
+ collected: list[BuildShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for b in iterator:
+ assert isinstance(b, BuildShort)
+ collected.append(b)
+ else:
+ assert isinstance(iterator, Iterator)
+ for b in iterator:
+ assert isinstance(b, BuildShort)
+ collected.append(b)
+
+ assert 1 <= len(collected) <= 5
+ for build in collected:
+ assert build.id is not None
+ assert build.act_id is not None
+
+
+async def test_user_builds_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over the user's builds."""
+ iterator = client.builds().iterate(limit=5)
+ collected: list[BuildShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for b in iterator:
+ assert isinstance(b, BuildShort)
+ collected.append(b)
+ else:
+ assert isinstance(iterator, Iterator)
+ for b in iterator:
+ assert isinstance(b, BuildShort)
+ collected.append(b)
+
+ assert len(collected) <= 5
+ for build in collected:
+ assert build.id is not None
+
+
+async def test_get_nonexistent_build_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that get() on a non-existent build returns None."""
+ build = await maybe_await(client.build('NoNeXiStEnTbUiLd').get())
+ assert build is None
diff --git a/tests/integration/test_dataset.py b/tests/integration/test_dataset.py
index 4a949ba4..1bd9429b 100644
--- a/tests/integration/test_dataset.py
+++ b/tests/integration/test_dataset.py
@@ -3,23 +3,26 @@
from __future__ import annotations
import json
+from collections.abc import AsyncIterator, Iterator
+from contextlib import AbstractAsyncContextManager, AbstractContextManager
from datetime import timedelta
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING
import impit
import pytest
-from ._utils import DatasetFixture, get_random_resource_name, maybe_await, maybe_sleep
-from apify_client._models import Dataset, DatasetStatistics, ListOfDatasets
+from .._utils import (
+ DatasetFixture,
+ collect_iterate_until_present,
+ get_random_resource_name,
+ maybe_await,
+ poll_until_condition,
+)
+from apify_client._models import Dataset, DatasetListItem, DatasetStatistics, ListOfDatasets
from apify_client._resource_clients.dataset import DatasetItemsPage
from apify_client.errors import ApifyApiError
if TYPE_CHECKING:
- from collections.abc import AsyncIterator, Iterator
- from contextlib import AbstractAsyncContextManager, AbstractContextManager
-
- from impit import Response
-
from apify_client import ApifyClient, ApifyClientAsync
@@ -142,24 +145,31 @@ async def test_iterate_items_signature(
match=r"Insufficient permissions for the dataset. Make sure you're passing a "
r'correct API token and that it has the required permissions.',
):
+ iterator = dataset.iterate_items()
if is_async:
- async for _ in cast('AsyncIterator[dict]', dataset.iterate_items()):
+ assert isinstance(iterator, AsyncIterator)
+ async for _ in iterator:
pass
else:
- for _ in cast('Iterator[dict]', dataset.iterate_items()):
+ assert isinstance(iterator, Iterator)
+ for _ in iterator:
pass
# Dataset content retrieved with correct signature
signature = test_dataset_of_another_user.signature
+ iterator = dataset.iterate_items(signature=signature)
+ collected_items: list[dict] = []
if is_async:
- collected_items = [
- item async for item in cast('AsyncIterator[dict]', dataset.iterate_items(signature=signature))
- ]
- assert test_dataset_of_another_user.expected_content == collected_items
+ assert isinstance(iterator, AsyncIterator)
+ async for item in iterator:
+ assert isinstance(item, dict)
+ collected_items.append(item)
else:
- assert test_dataset_of_another_user.expected_content == list(
- cast('Iterator[dict]', dataset.iterate_items(signature=signature))
- )
+ assert isinstance(iterator, Iterator)
+ for item in iterator:
+ assert isinstance(item, dict)
+ collected_items.append(item)
+ assert test_dataset_of_another_user.expected_content == collected_items
async def test_get_items_as_bytes_signature(
@@ -228,7 +238,7 @@ async def test_dataset_update(client: ApifyClient | ApifyClientAsync) -> None:
await maybe_await(dataset_client.delete())
-async def test_dataset_push_and_list_items(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_dataset_push_and_list_items(client: ApifyClient | ApifyClientAsync) -> None:
"""Test pushing items to dataset and listing them."""
dataset_name = get_random_resource_name('dataset')
@@ -245,12 +255,13 @@ async def test_dataset_push_and_list_items(client: ApifyClient | ApifyClientAsyn
]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
- # List items
- items_page = await maybe_await(dataset_client.list_items())
- assert isinstance(items_page, DatasetItemsPage)
+ items_page = await poll_until_condition(get_items, lambda page: len(page.items) == 3)
assert len(items_page.items) == 3
assert items_page.count == 3
# Note: items_page.total may be 0 immediately after push due to eventual consistency
@@ -264,7 +275,7 @@ async def test_dataset_push_and_list_items(client: ApifyClient | ApifyClientAsyn
await maybe_await(dataset_client.delete())
-async def test_dataset_list_items_with_pagination(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_dataset_list_items_with_pagination(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing items with pagination parameters."""
dataset_name = get_random_resource_name('dataset')
@@ -277,8 +288,13 @@ async def test_dataset_list_items_with_pagination(client: ApifyClient | ApifyCli
items_to_push = [{'index': i, 'value': i * 10} for i in range(10)]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 10)
# List with limit
items_page = await maybe_await(dataset_client.list_items(limit=5))
@@ -301,7 +317,7 @@ async def test_dataset_list_items_with_pagination(client: ApifyClient | ApifyCli
await maybe_await(dataset_client.delete())
-async def test_dataset_list_items_with_fields(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_dataset_list_items_with_fields(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing items with field filtering."""
dataset_name = get_random_resource_name('dataset')
@@ -317,12 +333,13 @@ async def test_dataset_list_items_with_fields(client: ApifyClient | ApifyClientA
]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency), listing with the fields filter
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items(fields=['id', 'name']))
+ assert isinstance(page, DatasetItemsPage)
+ return page
- # List with fields filter
- items_page = await maybe_await(dataset_client.list_items(fields=['id', 'name']))
- assert isinstance(items_page, DatasetItemsPage)
+ items_page = await poll_until_condition(get_items, lambda page: len(page.items) == 2)
assert len(items_page.items) == 2
# Verify only specified fields are returned
@@ -348,14 +365,27 @@ async def test_dataset_iterate_items(client: ApifyClient | ApifyClientAsync, *,
items_to_push = [{'index': i} for i in range(5)]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 5)
# Iterate over items
+ iterator = dataset_client.iterate_items()
+ collected_items: list[dict] = []
if is_async:
- collected_items = [item async for item in cast('AsyncIterator[dict]', dataset_client.iterate_items())]
+ assert isinstance(iterator, AsyncIterator)
+ async for item in iterator:
+ assert isinstance(item, dict)
+ collected_items.append(item)
else:
- collected_items = list(cast('Iterator[dict]', dataset_client.iterate_items()))
+ assert isinstance(iterator, Iterator)
+ for item in iterator:
+ assert isinstance(item, dict)
+ collected_items.append(item)
assert len(collected_items) == 5
for i, item in enumerate(collected_items):
@@ -380,7 +410,7 @@ async def test_dataset_delete_nonexistent(client: ApifyClient | ApifyClientAsync
assert retrieved_dataset is None
-async def test_dataset_get_statistics(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_dataset_get_statistics(client: ApifyClient | ApifyClientAsync) -> None:
"""Test getting dataset statistics."""
dataset_name = get_random_resource_name('dataset')
@@ -396,8 +426,13 @@ async def test_dataset_get_statistics(client: ApifyClient | ApifyClientAsync, *,
]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 2)
# Get statistics
statistics = await maybe_await(dataset_client.get_statistics())
@@ -409,6 +444,259 @@ async def test_dataset_get_statistics(client: ApifyClient | ApifyClientAsync, *,
await maybe_await(dataset_client.delete())
+async def test_dataset_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterating over the user's datasets across pages."""
+ created_ids: list[str] = []
+
+ # Create three datasets so pagination has work to do
+ for _ in range(3):
+ dataset = await maybe_await(client.datasets().get_or_create(name=get_random_resource_name('dataset')))
+ assert isinstance(dataset, Dataset)
+ created_ids.append(dataset.id)
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.datasets().iterate(desc=True),
+ set(created_ids),
+ item_type=DatasetListItem,
+ is_async=is_async,
+ )
+ collected_ids = {ds.id for ds in collected}
+ for created_id in created_ids:
+ assert created_id in collected_ids
+ finally:
+ for ds_id in created_ids:
+ await maybe_await(client.dataset(ds_id).delete())
+
+
+async def test_dataset_list_items_desc(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing items in descending order."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ items_to_push = [{'idx': i} for i in range(5)]
+ await maybe_await(dataset_client.push_items(items_to_push))
+
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 5)
+
+ # Default ordering - ascending
+ page_asc = await maybe_await(dataset_client.list_items())
+ assert isinstance(page_asc, DatasetItemsPage)
+ # Reversed ordering
+ page_desc = await maybe_await(dataset_client.list_items(desc=True))
+ assert isinstance(page_desc, DatasetItemsPage)
+
+ assert page_asc.desc is False
+ assert page_desc.desc is True
+ assert [item['idx'] for item in page_desc.items] == list(reversed([item['idx'] for item in page_asc.items]))
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
+async def test_dataset_list_items_omit_and_clean(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test list_items with `omit`, `clean`, `skip_hidden`, and `skip_empty` filters."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ # Mix of regular, hidden (`#`), and empty items to exercise filters
+ items_to_push = [
+ {'id': 1, 'name': 'visible', '#secret': 'shh', 'extra': 'X'},
+ {}, # empty item - filtered out by skip_empty/clean
+ {'id': 2, 'name': 'also visible', '#secret': 'shh', 'extra': 'Y'},
+ ]
+ await maybe_await(dataset_client.push_items(items_to_push))
+
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == len(items_to_push))
+
+ # `omit` should remove the `extra` field
+ omit_page = await maybe_await(dataset_client.list_items(omit=['extra']))
+ assert isinstance(omit_page, DatasetItemsPage)
+ for item in omit_page.items:
+ assert 'extra' not in item
+
+ # `clean=True` drops both hidden (`#secret`) and empty items
+ clean_page = await maybe_await(dataset_client.list_items(clean=True))
+ assert isinstance(clean_page, DatasetItemsPage)
+ assert all(item for item in clean_page.items) # no empties
+ for item in clean_page.items:
+ assert '#secret' not in item
+
+ # `skip_hidden=True` keeps empties but drops hidden fields
+ hidden_page = await maybe_await(dataset_client.list_items(skip_hidden=True))
+ assert isinstance(hidden_page, DatasetItemsPage)
+ for item in hidden_page.items:
+ assert '#secret' not in item
+
+ # `skip_empty=True` drops empty items but keeps hidden fields
+ empty_page = await maybe_await(dataset_client.list_items(skip_empty=True))
+ assert isinstance(empty_page, DatasetItemsPage)
+ non_empty_count = len([i for i in items_to_push if i])
+ assert len(empty_page.items) == non_empty_count
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
+async def test_dataset_iterate_items_chunked(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterate_items with a small chunk_size to force multiple API requests."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ items_to_push = [{'idx': i} for i in range(12)]
+ await maybe_await(dataset_client.push_items(items_to_push))
+
+ # Poll until all 12 items are visible (eventual consistency) so the chunked iteration sees every page
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items(limit=12))
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 12)
+
+ # chunk_size=5 forces 3 underlying pages for 12 items
+ iterator = dataset_client.iterate_items(chunk_size=5)
+ collected: list[dict] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for item in iterator:
+ assert isinstance(item, dict)
+ collected.append(item)
+ else:
+ assert isinstance(iterator, Iterator)
+ for item in iterator:
+ assert isinstance(item, dict)
+ collected.append(item)
+
+ assert len(collected) == 12
+ # Ordering across multiple paginated reads is not strictly guaranteed mid-flight,
+ # so compare by membership / sorted view rather than positional equality.
+ assert sorted(item['idx'] for item in collected) == list(range(12))
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
+async def test_dataset_iterate_items_with_fields(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterate_items with `fields` filter."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ items_to_push = [{'id': i, 'name': f'item-{i}', 'extra': 'drop-me'} for i in range(3)]
+ await maybe_await(dataset_client.push_items(items_to_push))
+
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 3)
+
+ iterator = dataset_client.iterate_items(fields=['id', 'name'])
+ collected: list[dict] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for item in iterator:
+ assert isinstance(item, dict)
+ collected.append(item)
+ else:
+ assert isinstance(iterator, Iterator)
+ for item in iterator:
+ assert isinstance(item, dict)
+ collected.append(item)
+
+ assert len(collected) == 3
+ for item in collected:
+ assert set(item.keys()) == {'id', 'name'}
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
+async def test_dataset_create_items_public_url(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test generating a signed public URL for dataset items and fetching from it."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ items = [{'id': i, 'value': i * 10} for i in range(3)]
+ await maybe_await(dataset_client.push_items(items))
+
+ # Poll until all items are visible (eventual consistency) so the public URL serves all of them
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 3)
+
+ public_url = await maybe_await(dataset_client.create_items_public_url(expires_in=timedelta(minutes=5)))
+ assert isinstance(public_url, str)
+ assert created_dataset.id in public_url
+ assert 'signature=' in public_url
+
+ # Fetch from the signed URL without any auth header - should succeed
+ response = impit.get(public_url)
+ assert response.status_code == 200
+ downloaded = json.loads(response.content)
+ assert downloaded == items
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
+async def test_dataset_get_items_as_bytes_csv(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test get_items_as_bytes with non-JSON item_format (csv)."""
+ dataset_name = get_random_resource_name('dataset')
+ created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
+ assert isinstance(created_dataset, Dataset)
+ dataset_client = client.dataset(created_dataset.id)
+
+ try:
+ items = [{'id': 1, 'name': 'first'}, {'id': 2, 'name': 'second'}]
+ await maybe_await(dataset_client.push_items(items))
+
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 2)
+
+ raw = await maybe_await(dataset_client.get_items_as_bytes(item_format='csv'))
+ assert isinstance(raw, bytes)
+ decoded = raw.decode('utf-8')
+ # CSV output should contain a header row and the values
+ assert 'id' in decoded
+ assert 'first' in decoded
+ assert 'second' in decoded
+ finally:
+ await maybe_await(dataset_client.delete())
+
+
async def test_dataset_stream_items(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test streaming dataset items."""
dataset_name = get_random_resource_name('dataset')
@@ -426,23 +714,29 @@ async def test_dataset_stream_items(client: ApifyClient | ApifyClientAsync, *, i
]
await maybe_await(dataset_client.push_items(items_to_push))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all items are visible (eventual consistency)
+ async def get_items() -> DatasetItemsPage:
+ page = await maybe_await(dataset_client.list_items())
+ assert isinstance(page, DatasetItemsPage)
+ return page
+
+ await poll_until_condition(get_items, lambda page: len(page.items) == 3)
# Stream items using context manager
+ stream_ctx = dataset_client.stream_items(item_format='json')
if is_async:
- stream_ctx = cast('AbstractAsyncContextManager[Response]', dataset_client.stream_items(item_format='json'))
+ assert isinstance(stream_ctx, AbstractAsyncContextManager)
async with stream_ctx as response:
- assert response is not None
+ assert isinstance(response, impit.Response)
assert response.status_code == 200
content = await response.aread()
items = json.loads(content)
assert len(items) == 3
assert items[0]['id'] == 1
else:
- stream_ctx = cast('AbstractContextManager[Response]', dataset_client.stream_items(item_format='json'))
+ assert isinstance(stream_ctx, AbstractContextManager)
with stream_ctx as response:
- assert response is not None
+ assert isinstance(response, impit.Response)
assert response.status_code == 200
content = response.read()
items = json.loads(content)
diff --git a/tests/integration/test_key_value_store.py b/tests/integration/test_key_value_store.py
index 1e30b9ae..6f4a561d 100644
--- a/tests/integration/test_key_value_store.py
+++ b/tests/integration/test_key_value_store.py
@@ -3,21 +3,26 @@
from __future__ import annotations
import json
+from collections.abc import AsyncIterator, Iterator
from datetime import timedelta
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING
import impit
import pytest
-from ._utils import KvsFixture, get_random_resource_name, maybe_await, maybe_sleep
-from apify_client._models import KeyValueStore, ListOfKeys, ListOfKeyValueStores
+from .._utils import (
+ KvsFixture,
+ collect_iterate_until_present,
+ get_random_resource_name,
+ maybe_await,
+ maybe_sleep,
+ poll_until_condition,
+)
+from apify_client._models import KeyValueStore, KeyValueStoreKey, ListOfKeys, ListOfKeyValueStores
from apify_client.errors import ApifyApiError
if TYPE_CHECKING:
- from collections.abc import AsyncIterator, Iterator
-
from apify_client import ApifyClient, ApifyClientAsync
- from apify_client._models import KeyValueStoreKey
async def test_key_value_store_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
@@ -250,7 +255,7 @@ async def test_key_value_store_update(client: ApifyClient | ApifyClientAsync) ->
await maybe_await(store_client.delete())
-async def test_key_value_store_set_and_get_record(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_key_value_store_set_and_get_record(client: ApifyClient | ApifyClientAsync) -> None:
"""Test setting and getting records from key-value store."""
store_name = get_random_resource_name('kvs')
@@ -263,11 +268,11 @@ async def test_key_value_store_set_and_get_record(client: ApifyClient | ApifyCli
test_value = {'name': 'Test Item', 'value': 123, 'nested': {'data': 'value'}}
await maybe_await(store_client.set_record('test-key', test_value))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the record is visible (eventual consistency)
+ async def get_record() -> dict | None:
+ return await maybe_await(store_client.get_record('test-key'))
- # Get the record
- record = await maybe_await(store_client.get_record('test-key'))
+ record = await poll_until_condition(get_record, lambda record: record is not None)
assert isinstance(record, dict)
assert record['key'] == 'test-key'
assert record['value'] == test_value
@@ -276,9 +281,7 @@ async def test_key_value_store_set_and_get_record(client: ApifyClient | ApifyCli
await maybe_await(store_client.delete())
-async def test_key_value_store_set_and_get_text_record(
- client: ApifyClient | ApifyClientAsync, *, is_async: bool
-) -> None:
+async def test_key_value_store_set_and_get_text_record(client: ApifyClient | ApifyClientAsync) -> None:
"""Test setting and getting text records."""
store_name = get_random_resource_name('kvs')
@@ -291,11 +294,11 @@ async def test_key_value_store_set_and_get_text_record(
test_text = 'Hello, this is a test text!'
await maybe_await(store_client.set_record('text-key', test_text, content_type='text/plain'))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the record is visible (eventual consistency)
+ async def get_record() -> dict | None:
+ return await maybe_await(store_client.get_record('text-key'))
- # Get the record
- record = await maybe_await(store_client.get_record('text-key'))
+ record = await poll_until_condition(get_record, lambda record: record is not None)
assert isinstance(record, dict)
assert record['key'] == 'text-key'
assert record['value'] == test_text
@@ -304,7 +307,7 @@ async def test_key_value_store_set_and_get_text_record(
await maybe_await(store_client.delete())
-async def test_key_value_store_list_keys(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_key_value_store_list_keys(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing keys in the key-value store."""
store_name = get_random_resource_name('kvs')
@@ -317,12 +320,13 @@ async def test_key_value_store_list_keys(client: ApifyClient | ApifyClientAsync,
for i in range(5):
await maybe_await(store_client.set_record(f'key-{i}', {'index': i}))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until all keys are visible (eventual consistency)
+ async def get_keys() -> ListOfKeys:
+ keys = await maybe_await(store_client.list_keys())
+ assert isinstance(keys, ListOfKeys)
+ return keys
- # List keys
- keys_response = await maybe_await(store_client.list_keys())
- assert isinstance(keys_response, ListOfKeys)
+ keys_response = await poll_until_condition(get_keys, lambda keys: len(keys.items) == 5)
assert len(keys_response.items) == 5
# Verify key names
@@ -333,7 +337,7 @@ async def test_key_value_store_list_keys(client: ApifyClient | ApifyClientAsync,
await maybe_await(store_client.delete())
-async def test_key_value_store_list_keys_with_limit(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_key_value_store_list_keys_with_limit(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing keys with limit parameter."""
store_name = get_random_resource_name('kvs')
@@ -346,18 +350,19 @@ async def test_key_value_store_list_keys_with_limit(client: ApifyClient | ApifyC
for i in range(10):
await maybe_await(store_client.set_record(f'item-{i:02d}', {'index': i}))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until enough keys are visible (eventual consistency), listing with the limit applied
+ async def get_keys() -> ListOfKeys:
+ keys = await maybe_await(store_client.list_keys(limit=5))
+ assert isinstance(keys, ListOfKeys)
+ return keys
- # List with limit
- keys_response = await maybe_await(store_client.list_keys(limit=5))
- assert isinstance(keys_response, ListOfKeys)
+ keys_response = await poll_until_condition(get_keys, lambda keys: len(keys.items) == 5)
assert len(keys_response.items) == 5
finally:
await maybe_await(store_client.delete())
-async def test_key_value_store_record_exists(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_key_value_store_record_exists(client: ApifyClient | ApifyClientAsync) -> None:
"""Test checking if a record exists."""
store_name = get_random_resource_name('kvs')
@@ -369,11 +374,13 @@ async def test_key_value_store_record_exists(client: ApifyClient | ApifyClientAs
# Set a record
await maybe_await(store_client.set_record('exists-key', {'data': 'value'}))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the record is visible (eventual consistency)
+ async def added_record_exists() -> bool:
+ exists = await maybe_await(store_client.record_exists('exists-key'))
+ assert isinstance(exists, bool)
+ return exists
- # Check existence
- exists = await maybe_await(store_client.record_exists('exists-key'))
+ exists = await poll_until_condition(added_record_exists)
assert exists is True
exists = await maybe_await(store_client.record_exists('non-existent-key'))
assert exists is False
@@ -381,7 +388,7 @@ async def test_key_value_store_record_exists(client: ApifyClient | ApifyClientAs
await maybe_await(store_client.delete())
-async def test_key_value_store_delete_record(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_key_value_store_delete_record(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting a record from the store."""
store_name = get_random_resource_name('kvs')
@@ -393,21 +400,18 @@ async def test_key_value_store_delete_record(client: ApifyClient | ApifyClientAs
# Set a record
await maybe_await(store_client.set_record('delete-me', {'data': 'value'}))
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the record is visible (eventual consistency)
+ async def get_record() -> dict | None:
+ return await maybe_await(store_client.get_record('delete-me'))
- # Verify it exists
- record = await maybe_await(store_client.get_record('delete-me'))
+ record = await poll_until_condition(get_record, lambda record: record is not None)
assert record is not None
# Delete the record
await maybe_await(store_client.delete_record('delete-me'))
- # Wait briefly
- await maybe_sleep(1, is_async=is_async)
-
- # Verify it's gone
- record = await maybe_await(store_client.get_record('delete-me'))
+ # Poll until the deletion is reflected (eventual consistency)
+ record = await poll_until_condition(get_record, lambda record: record is None)
assert record is None
finally:
await maybe_await(store_client.delete())
@@ -446,10 +450,18 @@ async def test_key_value_store_iterate_keys(client: ApifyClient | ApifyClientAsy
await maybe_sleep(1, is_async=is_async)
# Iterate over keys
+ iterator = store_client.iterate_keys()
+ collected_keys: list[KeyValueStoreKey] = []
if is_async:
- collected_keys = [key async for key in cast('AsyncIterator[KeyValueStoreKey]', store_client.iterate_keys())]
+ assert isinstance(iterator, AsyncIterator)
+ async for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
else:
- collected_keys = list(cast('Iterator[KeyValueStoreKey]', store_client.iterate_keys()))
+ assert isinstance(iterator, Iterator)
+ for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
assert len(collected_keys) == 5
@@ -480,12 +492,18 @@ async def test_key_value_store_iterate_keys_with_limit(
await maybe_sleep(1, is_async=is_async)
# Iterate with limit
+ iterator = store_client.iterate_keys(limit=5)
+ collected_keys: list[KeyValueStoreKey] = []
if is_async:
- collected_keys = [
- key async for key in cast('AsyncIterator[KeyValueStoreKey]', store_client.iterate_keys(limit=5))
- ]
+ assert isinstance(iterator, AsyncIterator)
+ async for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
else:
- collected_keys = list(cast('Iterator[KeyValueStoreKey]', store_client.iterate_keys(limit=5)))
+ assert isinstance(iterator, Iterator)
+ for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
assert len(collected_keys) == 5
finally:
@@ -513,16 +531,207 @@ async def test_key_value_store_iterate_keys_with_prefix(
await maybe_sleep(1, is_async=is_async)
# Iterate with prefix filter
+ iterator = store_client.iterate_keys(prefix='prefix-a-')
+ collected_keys: list[KeyValueStoreKey] = []
if is_async:
- collected_keys = [
- key
- async for key in cast('AsyncIterator[KeyValueStoreKey]', store_client.iterate_keys(prefix='prefix-a-'))
- ]
+ assert isinstance(iterator, AsyncIterator)
+ async for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
else:
- collected_keys = list(cast('Iterator[KeyValueStoreKey]', store_client.iterate_keys(prefix='prefix-a-')))
+ assert isinstance(iterator, Iterator)
+ for key in iterator:
+ assert isinstance(key, KeyValueStoreKey)
+ collected_keys.append(key)
assert len(collected_keys) == 3
for key in collected_keys:
assert key.key.startswith('prefix-a-')
finally:
await maybe_await(store_client.delete())
+
+
+async def test_key_value_store_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterating over the user's key-value stores."""
+ created_ids: list[str] = []
+
+ for _ in range(3):
+ kvs = await maybe_await(client.key_value_stores().get_or_create(name=get_random_resource_name('kvs')))
+ assert isinstance(kvs, KeyValueStore)
+ created_ids.append(kvs.id)
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.key_value_stores().iterate(desc=True),
+ set(created_ids),
+ item_type=KeyValueStore,
+ is_async=is_async,
+ )
+ collected_ids = {kvs.id for kvs in collected}
+ for created_id in created_ids:
+ assert created_id in collected_ids
+ finally:
+ for kvs_id in created_ids:
+ await maybe_await(client.key_value_store(kvs_id).delete())
+
+
+async def test_key_value_store_set_and_get_binary_record(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test setting and retrieving a binary (bytes) record."""
+ store_name = get_random_resource_name('kvs')
+ created_store = await maybe_await(client.key_value_stores().get_or_create(name=store_name))
+ assert isinstance(created_store, KeyValueStore)
+ store_client = client.key_value_store(created_store.id)
+
+ try:
+ # Store an explicit bytes value with a binary content type
+ binary_value = b'\x89PNG\r\n\x1a\n' + b'fake-png-bytes'
+ await maybe_await(store_client.set_record('image.png', binary_value, content_type='image/png'))
+
+ # Poll until the record is visible (eventual consistency);
+ # get_record_as_bytes returns raw bytes (no auto-decoding)
+ async def get_record() -> dict | None:
+ return await maybe_await(store_client.get_record_as_bytes('image.png'))
+
+ record = await poll_until_condition(get_record, lambda record: record is not None)
+ assert isinstance(record, dict)
+ assert record['key'] == 'image.png'
+ assert record['value'] == binary_value
+ assert 'image/png' in record['content_type']
+ finally:
+ await maybe_await(store_client.delete())
+
+
+async def test_key_value_store_get_record_public_url(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test get_record_public_url returns a working signed URL."""
+ store_name = get_random_resource_name('kvs')
+ created_store = await maybe_await(client.key_value_stores().get_or_create(name=store_name))
+ assert isinstance(created_store, KeyValueStore)
+ store_client = client.key_value_store(created_store.id)
+
+ try:
+ await maybe_await(store_client.set_record('my-record', {'hello': 'world'}))
+
+ # Poll until the record is visible (eventual consistency) so the public URL serves it
+ async def added_record_exists() -> bool:
+ exists = await maybe_await(store_client.record_exists('my-record'))
+ assert isinstance(exists, bool)
+ return exists
+
+ await poll_until_condition(added_record_exists)
+
+ public_url = await maybe_await(store_client.get_record_public_url('my-record'))
+ assert isinstance(public_url, str)
+ assert created_store.id in public_url
+ assert 'my-record' in public_url
+
+ # Fetching from the public URL should return the record
+ response = impit.get(public_url)
+ assert response.status_code == 200
+ assert json.loads(response.content) == {'hello': 'world'}
+ finally:
+ await maybe_await(store_client.delete())
+
+
+async def test_key_value_store_create_keys_public_url(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test create_keys_public_url returns a working signed URL for listing keys."""
+ store_name = get_random_resource_name('kvs')
+ created_store = await maybe_await(client.key_value_stores().get_or_create(name=store_name))
+ assert isinstance(created_store, KeyValueStore)
+ store_client = client.key_value_store(created_store.id)
+
+ try:
+ for i in range(3):
+ await maybe_await(store_client.set_record(f'key-{i}', {'idx': i}))
+
+ # Poll until all keys are visible (eventual consistency) so the public URL lists all of them
+ async def get_keys() -> ListOfKeys:
+ keys = await maybe_await(store_client.list_keys())
+ assert isinstance(keys, ListOfKeys)
+ return keys
+
+ await poll_until_condition(get_keys, lambda keys: len(keys.items) == 3)
+
+ public_url = await maybe_await(store_client.create_keys_public_url(limit=10, expires_in=timedelta(minutes=5)))
+ assert isinstance(public_url, str)
+ assert created_store.id in public_url
+ assert 'signature=' in public_url
+
+ # Fetching the URL should return a key listing
+ response = impit.get(public_url)
+ assert response.status_code == 200
+ data = json.loads(response.content)
+ keys = data.get('data', {}).get('items', [])
+ key_names = [k['key'] for k in keys]
+ for i in range(3):
+ assert f'key-{i}' in key_names
+ finally:
+ await maybe_await(store_client.delete())
+
+
+async def test_key_value_store_stream_record_own(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test streaming a record from one's own key-value store (no signature)."""
+ store_name = get_random_resource_name('kvs')
+ created_store = await maybe_await(client.key_value_stores().get_or_create(name=store_name))
+ assert isinstance(created_store, KeyValueStore)
+ store_client = client.key_value_store(created_store.id)
+
+ try:
+ await maybe_await(store_client.set_record('stream-key', {'data': 'streamed'}))
+
+ # Poll until the record is visible (eventual consistency) before streaming it
+ async def added_record_exists() -> bool:
+ exists = await maybe_await(store_client.record_exists('stream-key'))
+ assert isinstance(exists, bool)
+ return exists
+
+ await poll_until_condition(added_record_exists)
+
+ if is_async:
+ async with store_client.stream_record('stream-key') as stream: # ty: ignore[invalid-context-manager]
+ assert isinstance(stream, dict)
+ value = json.loads(stream['value'].content.decode('utf-8'))
+ else:
+ with store_client.stream_record('stream-key') as stream: # ty: ignore[invalid-context-manager]
+ assert isinstance(stream, dict)
+ value = json.loads(stream['value'].content.decode('utf-8'))
+
+ assert value == {'data': 'streamed'}
+ finally:
+ await maybe_await(store_client.delete())
+
+
+async def test_key_value_store_list_keys_with_exclusive_start_key(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing keys with the exclusive_start_key cursor parameter."""
+ store_name = get_random_resource_name('kvs')
+ created_store = await maybe_await(client.key_value_stores().get_or_create(name=store_name))
+ assert isinstance(created_store, KeyValueStore)
+ store_client = client.key_value_store(created_store.id)
+
+ try:
+ # Use zero-padded names so lexicographic order is predictable
+ for i in range(5):
+ await maybe_await(store_client.set_record(f'key-{i:02d}', {'idx': i}))
+
+ # Poll until all keys are visible (eventual consistency) so pagination is exercised, not truncated
+ async def get_keys() -> ListOfKeys:
+ keys = await maybe_await(store_client.list_keys())
+ assert isinstance(keys, ListOfKeys)
+ return keys
+
+ await poll_until_condition(get_keys, lambda keys: len(keys.items) == 5)
+
+ # First page
+ first_page = await maybe_await(store_client.list_keys(limit=2))
+ assert isinstance(first_page, ListOfKeys)
+ assert len(first_page.items) == 2
+
+ # Continue from the last key of the first page
+ last_key_of_first = first_page.items[-1].key
+ second_page = await maybe_await(store_client.list_keys(exclusive_start_key=last_key_of_first))
+ assert isinstance(second_page, ListOfKeys)
+
+ first_keys = {k.key for k in first_page.items}
+ second_keys = {k.key for k in second_page.items}
+ assert first_keys.isdisjoint(second_keys)
+ finally:
+ await maybe_await(store_client.delete())
diff --git a/tests/integration/test_log.py b/tests/integration/test_log.py
index 84eb09f0..df687e2f 100644
--- a/tests/integration/test_log.py
+++ b/tests/integration/test_log.py
@@ -2,10 +2,12 @@
from __future__ import annotations
+from contextlib import AbstractAsyncContextManager, AbstractContextManager
from typing import TYPE_CHECKING
-from ._utils import maybe_await
+from .._utils import maybe_await
from apify_client._models import ListOfBuilds, Run
+from apify_client.http_clients import HttpResponse
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
@@ -68,3 +70,32 @@ async def test_log_get_as_bytes(client: ApifyClient | ApifyClientAsync) -> None:
# Cleanup
await maybe_await(run_client.delete())
+
+
+async def test_log_stream_from_run(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test streaming a run's log via the stream() context manager."""
+ actor = client.actor(HELLO_WORLD_ACTOR)
+ run = await maybe_await(actor.call())
+ assert isinstance(run, Run)
+
+ run_client = client.run(run.id)
+ try:
+ log_client = run_client.log()
+
+ stream_ctx = log_client.stream()
+ if is_async:
+ assert isinstance(stream_ctx, AbstractAsyncContextManager)
+ async with stream_ctx as response:
+ assert isinstance(response, HttpResponse)
+ content = await response.aread()
+ assert isinstance(content, bytes)
+ assert len(content) > 0
+ else:
+ assert isinstance(stream_ctx, AbstractContextManager)
+ with stream_ctx as response:
+ assert isinstance(response, HttpResponse)
+ content = response.read()
+ assert isinstance(content, bytes)
+ assert len(content) > 0
+ finally:
+ await maybe_await(run_client.delete())
diff --git a/tests/integration/test_request_queue.py b/tests/integration/test_request_queue.py
index 03ffe0d6..4ad0105f 100644
--- a/tests/integration/test_request_queue.py
+++ b/tests/integration/test_request_queue.py
@@ -2,10 +2,17 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from datetime import timedelta
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, get_random_string, maybe_await, maybe_sleep
+from .._utils import (
+ collect_iterate_until_present,
+ get_random_resource_name,
+ get_random_string,
+ maybe_await,
+ poll_until_condition,
+)
from apify_client._models import (
BatchAddResult,
BatchDeleteResult,
@@ -13,9 +20,11 @@
ListOfRequests,
LockedRequestQueueHead,
Request,
+ RequestDraft,
RequestLockInfo,
RequestQueue,
RequestQueueHead,
+ RequestQueueShort,
RequestRegistration,
UnlockRequestsResult,
)
@@ -23,30 +32,30 @@
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
from apify_client._resource_clients.request_queue import RequestQueueClient, RequestQueueClientAsync
- from apify_client._typeddicts import RequestDict, RequestDraftDeleteDict, RequestDraftDict
+ from apify_client._typeddicts import (
+ RequestDict,
+ RequestDraftDeleteDict,
+ RequestDraftDict,
+ )
async def ensure_queue_is_populated(
rq_client: RequestQueueClient | RequestQueueClientAsync,
*,
expected_count: int,
- is_async: bool,
) -> None:
"""Poll the queue until `expected_count` requests are visible.
Uses `list_head` (without side effects) so polling does not lock items, which would otherwise
lead to an ambiguous count of actually-locked requests in tests that exercise locking.
"""
- head_response: RequestQueueHead | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_head(limit=expected_count))
- assert isinstance(result, RequestQueueHead)
- head_response = result
- if len(head_response.items) == expected_count:
- break
-
- assert head_response is not None
+
+ async def get_head() -> RequestQueueHead:
+ head = await maybe_await(rq_client.list_head(limit=expected_count))
+ assert isinstance(head, RequestQueueHead)
+ return head
+
+ head_response = await poll_until_condition(get_head, lambda head: len(head.items) == expected_count)
assert len(head_response.items) == expected_count
@@ -85,7 +94,7 @@ async def test_request_queue_collection_get_or_create(client: ApifyClient | Apif
await maybe_await(client.request_queue(rq.id).delete())
-async def test_request_queue_lock(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_lock(client: ApifyClient | ApifyClientAsync) -> None:
created_rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('queue')))
assert isinstance(created_rq, RequestQueue)
rq = client.request_queue(created_rq.id, client_key=get_random_string(10))
@@ -98,16 +107,12 @@ async def test_request_queue_lock(client: ApifyClient | ApifyClientAsync, *, is_
)
# Poll until all requests are available for locking (eventual consistency)
- get_head_and_lock_response: LockedRequestQueueHead | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq.list_and_lock_head(limit=10, lock_duration=timedelta(seconds=10)))
- assert isinstance(result, LockedRequestQueueHead)
- get_head_and_lock_response = result
- if len(get_head_and_lock_response.items) == 10:
- break
-
- assert get_head_and_lock_response is not None
+ async def lock_head() -> LockedRequestQueueHead:
+ head = await maybe_await(rq.list_and_lock_head(limit=10, lock_duration=timedelta(seconds=10)))
+ assert isinstance(head, LockedRequestQueueHead)
+ return head
+
+ get_head_and_lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 10)
assert len(get_head_and_lock_response.items) == 10
for locked_request in get_head_and_lock_response.items:
@@ -189,7 +194,7 @@ async def test_request_queue_update(client: ApifyClient | ApifyClientAsync) -> N
await maybe_await(rq_client.delete())
-async def test_request_queue_add_and_get_request(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_add_and_get_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test adding and getting a request from the queue."""
rq_name = get_random_resource_name('queue')
@@ -209,11 +214,11 @@ async def test_request_queue_add_and_get_request(client: ApifyClient | ApifyClie
assert add_result.request_id is not None
assert add_result.was_already_present is False
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the request is visible (eventual consistency)
+ async def get_added_request() -> Request | None:
+ return await maybe_await(rq_client.get_request(add_result.request_id))
- # Get the request
- request = await maybe_await(rq_client.get_request(add_result.request_id))
+ request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert isinstance(request, Request)
assert str(request.url) == 'https://example.com/test'
assert request.unique_key == 'test-key-1'
@@ -221,7 +226,7 @@ async def test_request_queue_add_and_get_request(client: ApifyClient | ApifyClie
await maybe_await(rq_client.delete())
-async def test_request_queue_list_head(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_list_head(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing requests from the head of the queue."""
rq_name = get_random_resource_name('queue')
@@ -237,22 +242,18 @@ async def test_request_queue_list_head(client: ApifyClient | ApifyClientAsync, *
)
# Poll until requests are available (eventual consistency)
- head_response: RequestQueueHead | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_head(limit=3))
- assert isinstance(result, RequestQueueHead)
- head_response = result
- if len(head_response.items) == 3:
- break
-
- assert head_response is not None
+ async def get_head() -> RequestQueueHead:
+ head = await maybe_await(rq_client.list_head(limit=3))
+ assert isinstance(head, RequestQueueHead)
+ return head
+
+ head_response = await poll_until_condition(get_head, lambda head: len(head.items) == 3)
assert len(head_response.items) == 3
finally:
await maybe_await(rq_client.delete())
-async def test_request_queue_list_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_list_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing all requests in the queue."""
rq_name = get_random_resource_name('queue')
@@ -268,22 +269,18 @@ async def test_request_queue_list_requests(client: ApifyClient | ApifyClientAsyn
)
# Poll until all requests are available (eventual consistency)
- list_response: ListOfRequests | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_requests())
- assert isinstance(result, ListOfRequests)
- list_response = result
- if len(list_response.items) == 5:
- break
-
- assert list_response is not None
+ async def get_requests() -> ListOfRequests:
+ response = await maybe_await(rq_client.list_requests())
+ assert isinstance(response, ListOfRequests)
+ return response
+
+ list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 5)
assert len(list_response.items) == 5
finally:
await maybe_await(rq_client.delete())
-async def test_request_queue_delete_request(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_delete_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting a request from the queue."""
rq_name = get_random_resource_name('queue')
@@ -298,27 +295,24 @@ async def test_request_queue_delete_request(client: ApifyClient | ApifyClientAsy
)
assert isinstance(add_result, RequestRegistration)
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the request is visible (eventual consistency)
+ async def get_added_request() -> Request | None:
+ return await maybe_await(rq_client.get_request(add_result.request_id))
- # Verify it exists
- request = await maybe_await(rq_client.get_request(add_result.request_id))
+ request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert request is not None
# Delete the request
await maybe_await(rq_client.delete_request(add_result.request_id))
- # Wait briefly
- await maybe_sleep(1, is_async=is_async)
-
- # Verify it's gone
- deleted_request = await maybe_await(rq_client.get_request(add_result.request_id))
+ # Poll until the deletion is reflected (eventual consistency)
+ deleted_request = await poll_until_condition(get_added_request, lambda request: request is None)
assert deleted_request is None
finally:
await maybe_await(rq_client.delete())
-async def test_request_queue_batch_add_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_batch_add_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test adding multiple requests in batch."""
rq_name = get_random_resource_name('queue')
@@ -337,22 +331,18 @@ async def test_request_queue_batch_add_requests(client: ApifyClient | ApifyClien
assert len(batch_response.unprocessed_requests) == 0
# Poll until all requests are available (eventual consistency)
- list_response: ListOfRequests | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_requests())
- assert isinstance(result, ListOfRequests)
- list_response = result
- if len(list_response.items) == 10:
- break
-
- assert list_response is not None
+ async def get_requests() -> ListOfRequests:
+ response = await maybe_await(rq_client.list_requests())
+ assert isinstance(response, ListOfRequests)
+ return response
+
+ list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 10)
assert len(list_response.items) == 10
finally:
await maybe_await(rq_client.delete())
-async def test_request_queue_batch_delete_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_batch_delete_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting multiple requests in batch."""
rq_name = get_random_resource_name('queue')
@@ -368,16 +358,12 @@ async def test_request_queue_batch_delete_requests(client: ApifyClient | ApifyCl
)
# Poll until all requests are available (eventual consistency)
- list_response: ListOfRequests | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_requests())
- assert isinstance(result, ListOfRequests)
- list_response = result
- if len(list_response.items) == 10:
- break
-
- assert list_response is not None
+ async def get_requests() -> ListOfRequests:
+ response = await maybe_await(rq_client.list_requests())
+ assert isinstance(response, ListOfRequests)
+ return response
+
+ list_response = await poll_until_condition(get_requests, lambda response: len(response.items) == 10)
assert len(list_response.items) == 10
requests_to_delete: list[RequestDraftDeleteDict] = []
for item in list_response.items[:5]:
@@ -390,16 +376,7 @@ async def test_request_queue_batch_delete_requests(client: ApifyClient | ApifyCl
assert len(delete_response.processed_requests) == 5
# Poll until deletions are reflected (eventual consistency)
- remaining: ListOfRequests | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_requests())
- assert isinstance(result, ListOfRequests)
- remaining = result
- if len(remaining.items) == 5:
- break
-
- assert remaining is not None
+ remaining = await poll_until_condition(get_requests, lambda response: len(response.items) == 5)
assert len(remaining.items) == 5
finally:
await maybe_await(rq_client.delete())
@@ -421,7 +398,7 @@ async def test_request_queue_delete_nonexistent(client: ApifyClient | ApifyClien
assert retrieved_rq is None
-async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClientAsync) -> None:
"""Test locking requests from the head of the queue."""
rq_name = get_random_resource_name('queue')
@@ -436,7 +413,7 @@ async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClien
rq_client.add_request({'url': f'https://example.com/lock-{i}', 'unique_key': f'lock-{i}'})
)
- await ensure_queue_is_populated(rq_client, expected_count=5, is_async=is_async)
+ await ensure_queue_is_populated(rq_client, expected_count=5)
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
assert isinstance(result, LockedRequestQueueHead)
@@ -451,7 +428,7 @@ async def test_request_queue_list_and_lock_head(client: ApifyClient | ApifyClien
await maybe_await(rq_client.delete())
-async def test_request_queue_prolong_request_lock(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_prolong_request_lock(client: ApifyClient | ApifyClientAsync) -> None:
"""Test prolonging a request lock."""
rq_name = get_random_resource_name('queue')
@@ -464,16 +441,12 @@ async def test_request_queue_prolong_request_lock(client: ApifyClient | ApifyCli
await maybe_await(rq_client.add_request({'url': 'https://example.com/prolong', 'unique_key': 'prolong-test'}))
# Poll until the request is available for locking (eventual consistency)
- lock_response: LockedRequestQueueHead | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
- assert isinstance(result, LockedRequestQueueHead)
- lock_response = result
- if len(lock_response.items) == 1:
- break
-
- assert lock_response is not None
+ async def lock_head() -> LockedRequestQueueHead:
+ head = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
+ assert isinstance(head, LockedRequestQueueHead)
+ return head
+
+ lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 1)
assert len(lock_response.items) == 1
locked_request = lock_response.items[0]
original_lock_expires = locked_request.lock_expires_at
@@ -489,7 +462,7 @@ async def test_request_queue_prolong_request_lock(client: ApifyClient | ApifyCli
await maybe_await(rq_client.delete())
-async def test_request_queue_delete_request_lock(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_delete_request_lock(client: ApifyClient | ApifyClientAsync) -> None:
"""Test deleting a request lock."""
rq_name = get_random_resource_name('queue')
@@ -502,16 +475,12 @@ async def test_request_queue_delete_request_lock(client: ApifyClient | ApifyClie
await maybe_await(rq_client.add_request({'url': 'https://example.com/unlock', 'unique_key': 'unlock-test'}))
# Poll until the request is available for locking (eventual consistency)
- lock_response: LockedRequestQueueHead | None = None
- for _ in range(5):
- await maybe_sleep(1, is_async=is_async)
- result = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
- assert isinstance(result, LockedRequestQueueHead)
- lock_response = result
- if len(lock_response.items) == 1:
- break
-
- assert lock_response is not None
+ async def lock_head() -> LockedRequestQueueHead:
+ head = await maybe_await(rq_client.list_and_lock_head(limit=1, lock_duration=timedelta(seconds=60)))
+ assert isinstance(head, LockedRequestQueueHead)
+ return head
+
+ lock_response = await poll_until_condition(lock_head, lambda head: len(head.items) == 1)
assert len(lock_response.items) == 1
locked_request = lock_response.items[0]
@@ -526,7 +495,7 @@ async def test_request_queue_delete_request_lock(client: ApifyClient | ApifyClie
await maybe_await(rq_client.delete())
-async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAsync) -> None:
"""Test unlocking all requests locked by the client."""
rq_name = get_random_resource_name('queue')
@@ -541,12 +510,23 @@ async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAs
rq_client.add_request({'url': f'https://example.com/unlock-{i}', 'unique_key': f'unlock-{i}'})
)
- await ensure_queue_is_populated(rq_client, expected_count=5, is_async=is_async)
+ await ensure_queue_is_populated(rq_client, expected_count=5)
result = await maybe_await(rq_client.list_and_lock_head(limit=3, lock_duration=timedelta(seconds=60)))
assert isinstance(result, LockedRequestQueueHead)
lock_response = result
assert len(lock_response.items) == 3
+ locked_ids = {item.id for item in lock_response.items}
+
+ # Locks are acknowledged before they are visible to subsequent reads, so unlocking immediately can
+ # see fewer locks than were just acquired. Since locked requests are excluded from the queue head,
+ # poll `list_head` until the locked IDs disappear from it (best-effort mitigation of the race).
+ async def all_locks_visible() -> bool:
+ head = await maybe_await(rq_client.list_head(limit=5))
+ assert isinstance(head, RequestQueueHead)
+ return locked_ids.isdisjoint(item.id for item in head.items)
+
+ await poll_until_condition(all_locks_visible, timeout=30, poll_interval=1)
# Unlock all requests
unlock_response = await maybe_await(rq_client.unlock_requests())
@@ -556,7 +536,7 @@ async def test_request_queue_unlock_requests(client: ApifyClient | ApifyClientAs
await maybe_await(rq_client.delete())
-async def test_request_queue_update_request(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_request_queue_update_request(client: ApifyClient | ApifyClientAsync) -> None:
"""Test updating a request in the queue."""
rq_name = get_random_resource_name('queue')
@@ -575,11 +555,11 @@ async def test_request_queue_update_request(client: ApifyClient | ApifyClientAsy
assert isinstance(add_result, RequestRegistration)
assert add_result.request_id is not None
- # Wait briefly for eventual consistency
- await maybe_sleep(1, is_async=is_async)
+ # Poll until the request is visible (eventual consistency), then use its full data
+ async def get_added_request() -> Request | None:
+ return await maybe_await(rq_client.get_request(add_result.request_id))
- # Get the request to get its full data
- original_request = await maybe_await(rq_client.get_request(add_result.request_id))
+ original_request = await poll_until_condition(get_added_request, lambda request: request is not None)
assert isinstance(original_request, Request)
assert original_request.unique_key is not None
@@ -596,3 +576,121 @@ async def test_request_queue_update_request(client: ApifyClient | ApifyClientAsy
assert update_result.request_id == add_result.request_id
finally:
await maybe_await(rq_client.delete())
+
+
+async def test_request_queue_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user request queues."""
+ created_ids: list[str] = []
+
+ for _ in range(3):
+ rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
+ assert isinstance(rq, RequestQueue)
+ created_ids.append(rq.id)
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.request_queues().iterate(desc=True),
+ set(created_ids),
+ item_type=RequestQueueShort,
+ is_async=is_async,
+ )
+ collected_ids = {rq.id for rq in collected}
+ for rq_id in created_ids:
+ assert rq_id in collected_ids
+ finally:
+ for rq_id in created_ids:
+ await maybe_await(client.request_queue(rq_id).delete())
+
+
+async def test_request_queue_iterate_requests(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over requests within a queue."""
+ rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
+ assert isinstance(rq, RequestQueue)
+ rq_client = client.request_queue(rq.id)
+
+ try:
+ # Add several requests
+ added_urls: list[str] = []
+ for i in range(7):
+ request_draft = RequestDraft(url=f'https://example.com/page-{i}', unique_key=f'unique-{i}')
+ await maybe_await(rq_client.add_request(request_draft))
+ added_urls.append(request_draft.url)
+
+ # Wait until all 7 requests are indexed (eventual consistency)
+ await ensure_queue_is_populated(rq_client, expected_count=7)
+
+ # Iterate with a small chunk so multiple pages are fetched
+ iterator = rq_client.iterate_requests(chunk_size=3)
+ collected: list[Request] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for req in iterator:
+ assert isinstance(req, Request)
+ collected.append(req)
+ else:
+ assert isinstance(iterator, Iterator)
+ for req in iterator:
+ assert isinstance(req, Request)
+ collected.append(req)
+
+ assert len(collected) == 7
+ collected_urls = {r.url for r in collected if r.url is not None}
+ for url in added_urls:
+ assert url in collected_urls
+ finally:
+ await maybe_await(rq_client.delete())
+
+
+async def test_request_queue_list_requests_with_cursor(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test list_requests pagination via limit and the opaque cursor token."""
+ rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
+ assert isinstance(rq, RequestQueue)
+ rq_client = client.request_queue(rq.id)
+
+ try:
+ for i in range(5):
+ await maybe_await(
+ rq_client.add_request(RequestDraft(url=f'https://example.com/p-{i}', unique_key=f'u-{i}'))
+ )
+
+ # Wait for all 5 requests to be indexed so pagination is exercised, not truncated
+ await ensure_queue_is_populated(rq_client, expected_count=5)
+
+ # First page
+ first_page = await maybe_await(rq_client.list_requests(limit=2))
+ assert isinstance(first_page, ListOfRequests)
+ assert len(first_page.items) == 2
+
+ # The API must return a continuation token when more pages exist (5 items, limit=2)
+ assert first_page.next_cursor is not None
+ second_page = await maybe_await(rq_client.list_requests(limit=10, cursor=first_page.next_cursor))
+ assert isinstance(second_page, ListOfRequests)
+
+ first_ids = {r.id for r in first_page.items}
+ second_ids = {r.id for r in second_page.items}
+ assert first_ids.isdisjoint(second_ids)
+ finally:
+ await maybe_await(rq_client.delete())
+
+
+async def test_request_queue_list_requests_with_filter(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test list_requests with the `filter` parameter (pending only)."""
+ rq = await maybe_await(client.request_queues().get_or_create(name=get_random_resource_name('rq')))
+ assert isinstance(rq, RequestQueue)
+ rq_client = client.request_queue(rq.id)
+
+ try:
+ for i in range(3):
+ await maybe_await(
+ rq_client.add_request(RequestDraft(url=f'https://example.com/f-{i}', unique_key=f'f-{i}'))
+ )
+
+ # Wait for all 3 requests to be indexed before filtering
+ await ensure_queue_is_populated(rq_client, expected_count=3)
+
+ # All three requests are pending - filter=['pending'] should return all of them.
+ pending_page = await maybe_await(rq_client.list_requests(filter=['pending']))
+ assert isinstance(pending_page, ListOfRequests)
+ assert len(pending_page.items) == 3
+ finally:
+ await maybe_await(rq_client.delete())
diff --git a/tests/integration/test_run.py b/tests/integration/test_run.py
index 9cfd24fb..5a3ecfac 100644
--- a/tests/integration/test_run.py
+++ b/tests/integration/test_run.py
@@ -2,11 +2,12 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from datetime import UTC, datetime, timedelta
from typing import TYPE_CHECKING
-from ._utils import maybe_await, maybe_sleep
-from apify_client._models import Dataset, KeyValueStore, ListOfRuns, RequestQueue, Run
+from .._utils import maybe_await, poll_until_condition
+from apify_client._models import Dataset, KeyValueStore, ListOfRuns, RequestQueue, Run, RunShort
from apify_client.errors import ApifyApiError
if TYPE_CHECKING:
@@ -278,7 +279,7 @@ async def test_run_runs_client(client: ApifyClient | ApifyClientAsync) -> None:
assert first_run.act_id is not None
-async def test_run_metamorph(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_run_metamorph(client: ApifyClient | ApifyClientAsync) -> None:
"""Test metamorphing a run into another Actor."""
# Start an actor that will run long enough to metamorph. We use hello-world and try to metamorph it into itself
actor = client.actor(HELLO_WORLD_ACTOR)
@@ -289,8 +290,13 @@ async def test_run_metamorph(client: ApifyClient | ApifyClientAsync, *, is_async
run_client = client.run(run.id)
try:
- # Wait a bit for the run to start properly
- await maybe_sleep(2, is_async=is_async)
+ # Wait until the run starts (leaves READY), with exponential backoff: container startup time varies widely
+ async def get_run() -> Run | None:
+ return await maybe_await(run_client.get())
+
+ await poll_until_condition(
+ get_run, lambda run: isinstance(run, Run) and run.status != 'READY', timeout=30, backoff_factor=2
+ )
# Metamorph the run into the same actor (allowed) with new input
# Note: hello-world may finish before we can metamorph, so we handle that case
@@ -317,7 +323,7 @@ async def test_run_metamorph(client: ApifyClient | ApifyClientAsync, *, is_async
await maybe_await(run_client.delete())
-async def test_run_reboot(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+async def test_run_reboot(client: ApifyClient | ApifyClientAsync) -> None:
"""Test rebooting a running Actor."""
# Start an actor
actor = client.actor(HELLO_WORLD_ACTOR)
@@ -328,9 +334,13 @@ async def test_run_reboot(client: ApifyClient | ApifyClientAsync, *, is_async: b
run_client = client.run(run.id)
try:
- # Wait a bit and check if the run is still running
- await maybe_sleep(1, is_async=is_async)
- current_run = await maybe_await(run_client.get())
+ # Wait until the run starts (leaves READY), with exponential backoff: container startup time varies widely
+ async def get_run() -> Run | None:
+ return await maybe_await(run_client.get())
+
+ current_run = await poll_until_condition(
+ get_run, lambda run: isinstance(run, Run) and run.status != 'READY', timeout=30, backoff_factor=2
+ )
# Only try to reboot if the run is still running
# Note: There's a race condition - run may finish between check and reboot call
@@ -354,11 +364,7 @@ async def test_run_reboot(client: ApifyClient | ApifyClientAsync, *, is_async: b
async def test_run_charge(client: ApifyClient | ApifyClientAsync) -> None:
- """Test charging for an event in a pay-per-event run.
-
- Note: This test may fail if the actor is not a pay-per-event actor. The test verifies that the charge method can
- be called correctly.
- """
+ """Test charging for an event in a pay-per-event run."""
# Run an actor
actor = client.actor(HELLO_WORLD_ACTOR)
run = await maybe_await(actor.call())
@@ -379,3 +385,70 @@ async def test_run_charge(client: ApifyClient | ApifyClientAsync) -> None:
finally:
await maybe_await(run_client.delete())
+
+
+async def test_runs_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user runs."""
+ iterator = client.runs().iterate(limit=5)
+ collected: list[RunShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for run in iterator:
+ assert isinstance(run, RunShort)
+ collected.append(run)
+ else:
+ assert isinstance(iterator, Iterator)
+ for run in iterator:
+ assert isinstance(run, RunShort)
+ collected.append(run)
+
+ assert len(collected) <= 5
+ for run in collected:
+ assert run.id is not None
+ assert run.act_id is not None
+
+
+async def test_run_collection_list_desc(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that desc=True returns runs sorted by started_at descending."""
+ runs_page = await maybe_await(client.runs().list(limit=10, desc=True))
+ assert isinstance(runs_page, ListOfRuns)
+
+ # The user run feed is shared across parallel test workers — brand-new RUNNING runs may
+ # briefly lack `started_at`. Compare ordering on the timestamps that are present.
+ timestamps = [run.started_at for run in runs_page.items if run.started_at is not None]
+ if len(timestamps) >= 2:
+ assert timestamps == sorted(timestamps, reverse=True)
+
+
+async def test_run_get_nonexistent_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that get() on a non-existent run returns None."""
+ run = await maybe_await(client.run('NoNExIsTeNtRuNiD123').get())
+ assert run is None
+
+
+async def test_run_collection_iterate_actor_runs(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test iterating over runs of a specific Actor."""
+ actor = client.actor(HELLO_WORLD_ACTOR)
+ # Ensure at least one run exists
+ run = await maybe_await(actor.call())
+ assert isinstance(run, Run)
+
+ try:
+ iterator = actor.runs().iterate(limit=3, desc=True)
+ collected: list[RunShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for r in iterator:
+ assert isinstance(r, RunShort)
+ collected.append(r)
+ else:
+ assert isinstance(iterator, Iterator)
+ for r in iterator:
+ assert isinstance(r, RunShort)
+ collected.append(r)
+
+ assert len(collected) >= 1
+ # All returned runs must be scoped to the requested actor.
+ assert all(r.act_id == run.act_id for r in collected)
+ finally:
+ await maybe_await(client.run(run.id).delete())
diff --git a/tests/integration/test_schedule.py b/tests/integration/test_schedule.py
index 1cf4f95d..0d136a59 100644
--- a/tests/integration/test_schedule.py
+++ b/tests/integration/test_schedule.py
@@ -4,8 +4,8 @@
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
-from apify_client._models import ListOfSchedules, Schedule
+from .._utils import collect_iterate_until_present, get_random_resource_name, maybe_await
+from apify_client._models import Actor, ListOfSchedules, Schedule, ScheduleActionRunActor, ScheduleShort
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
@@ -173,3 +173,81 @@ async def test_schedule_get_log(client: ApifyClient | ApifyClientAsync) -> None:
finally:
await maybe_await(schedule_client.delete())
+
+
+async def test_schedule_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user schedules."""
+ created_ids: list[str] = []
+
+ for _ in range(3):
+ schedule = await maybe_await(
+ client.schedules().create(
+ cron_expression='0 0 * * *',
+ is_enabled=False,
+ is_exclusive=False,
+ name=get_random_resource_name('schedule'),
+ )
+ )
+ assert isinstance(schedule, Schedule)
+ created_ids.append(schedule.id)
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.schedules().iterate(),
+ set(created_ids),
+ item_type=ScheduleShort,
+ is_async=is_async,
+ )
+ collected_ids = {s.id for s in collected}
+ for sched_id in created_ids:
+ assert sched_id in collected_ids
+ finally:
+ for sched_id in created_ids:
+ await maybe_await(client.schedule(sched_id).delete())
+
+
+async def test_schedule_with_actor_action(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test creating a schedule that runs an Actor on a cron expression."""
+ actor = await maybe_await(client.actor('apify/hello-world').get())
+ assert isinstance(actor, Actor)
+
+ schedule_name = get_random_resource_name('schedule')
+ created_schedule = await maybe_await(
+ client.schedules().create(
+ cron_expression='0 0 * * *',
+ is_enabled=False,
+ is_exclusive=False,
+ name=schedule_name,
+ actions=[
+ {
+ 'type': 'RUN_ACTOR',
+ 'actorId': actor.id,
+ }
+ ],
+ )
+ )
+ assert isinstance(created_schedule, Schedule)
+ schedule_client = client.schedule(created_schedule.id)
+
+ try:
+ # The created schedule should expose its action with the Actor ID.
+ assert created_schedule.actions is not None
+ assert len(created_schedule.actions) == 1
+ action = created_schedule.actions[0]
+ assert isinstance(action, ScheduleActionRunActor)
+ assert action.type == 'RUN_ACTOR'
+ assert action.actor_id == actor.id
+
+ # Round-trip: re-fetching from the API should preserve the action
+ retrieved = await maybe_await(schedule_client.get())
+ assert isinstance(retrieved, Schedule)
+ assert retrieved.actions is not None
+ assert len(retrieved.actions) == 1
+ finally:
+ await maybe_await(schedule_client.delete())
+
+
+async def test_schedule_get_nonexistent_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that get() on a non-existent schedule returns None."""
+ schedule = await maybe_await(client.schedule('NoNeXiStEnT').get())
+ assert schedule is None
diff --git a/tests/integration/test_store.py b/tests/integration/test_store.py
index 1ca17f69..dfacc87d 100644
--- a/tests/integration/test_store.py
+++ b/tests/integration/test_store.py
@@ -2,10 +2,13 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from typing import TYPE_CHECKING
-from ._utils import maybe_await
-from apify_client._models import ListOfStoreActors
+import pytest
+
+from .._utils import maybe_await
+from apify_client._models import ListOfStoreActors, StoreListActor
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
@@ -36,3 +39,101 @@ async def test_store_list_pagination(client: ApifyClient | ApifyClientAsync) ->
# Verify different results (if enough actors exist)
if len(page1.items) == 5 and len(page2.items) > 0:
assert page1.items[0].id != page2.items[0].id
+
+
+@pytest.mark.parametrize('pricing_model', ['FREE', 'FLAT_PRICE_PER_MONTH', 'PRICE_PER_DATASET_ITEM', 'PAY_PER_EVENT'])
+async def test_store_list_filter_by_pricing_model(client: ApifyClient | ApifyClientAsync, pricing_model: str) -> None:
+ """Test listing store actors filtered by each supported pricing model.
+
+ This exercises both the filter parameter and the Pydantic models that parse the responses for each
+ pricing variant.
+ """
+ page = await maybe_await(client.store().list(limit=10, pricing_model=pricing_model))
+ assert isinstance(page, ListOfStoreActors)
+ assert isinstance(page.items, list)
+
+ for actor in page.items:
+ # current_pricing_info is optional; when present its pricing_model must match the filter
+ cp = getattr(actor, 'current_pricing_info', None)
+ if cp is not None and hasattr(cp, 'pricing_model'):
+ assert cp.pricing_model == pricing_model
+
+
+async def test_store_list_filter_by_username(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing store actors filtered by a known username (apify)."""
+ page = await maybe_await(client.store().list(limit=10, username='apify'))
+ assert isinstance(page, ListOfStoreActors)
+ assert len(page.items) > 0
+ for actor in page.items:
+ assert actor.username == 'apify'
+
+
+async def test_store_list_sort_by_popularity(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test listing store actors sorted by popularity (a known API-supported sort field)."""
+ page = await maybe_await(client.store().list(limit=10, sort_by='popularity'))
+ assert isinstance(page, ListOfStoreActors)
+ assert len(page.items) > 0
+ # `popularity` is a composite ranking, not a strict sort on any single field, so we only
+ # check the directional invariant: the top-ranked item has at least as many total users as
+ # the bottom-ranked one on the page.
+ total_users = [a.stats.total_users for a in page.items if a.stats.total_users is not None]
+ assert total_users, 'expected at least one item with populated stats.total_users'
+ assert total_users[0] >= total_users[-1]
+
+
+async def test_store_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over store Actors."""
+ iterator = client.store().iterate(limit=20)
+ collected: list[StoreListActor] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for a in iterator:
+ assert isinstance(a, StoreListActor)
+ collected.append(a)
+ else:
+ assert isinstance(iterator, Iterator)
+ for a in iterator:
+ assert isinstance(a, StoreListActor)
+ collected.append(a)
+
+ assert len(collected) > 0
+ assert len(collected) <= 20
+ seen_ids = set()
+ for actor in collected:
+ assert actor.id is not None
+ # IDs should be unique across pages
+ assert actor.id not in seen_ids
+ seen_ids.add(actor.id)
+
+
+async def test_store_iterate_filter_by_username(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration with a username filter applied."""
+ iterator = client.store().iterate(limit=15, username='apify')
+ collected: list[StoreListActor] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for a in iterator:
+ assert isinstance(a, StoreListActor)
+ collected.append(a)
+ else:
+ assert isinstance(iterator, Iterator)
+ for a in iterator:
+ assert isinstance(a, StoreListActor)
+ collected.append(a)
+
+ assert len(collected) > 0
+ for actor in collected:
+ assert actor.username == 'apify'
+
+
+async def test_store_list_parses_full_first_page(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that store.list() parses every item on a 100-actor first page."""
+ page = await maybe_await(client.store().list(limit=100))
+ assert isinstance(page, ListOfStoreActors)
+ # All items have already been validated by Pydantic via `model_validate`. Touch a few
+ # fields to make the assertion concrete and to ensure the page wasn't empty.
+ assert page.items, f'{type(page).__name__} returned an empty items list — unexpected for the public store'
+ for item in page.items:
+ assert item.id
+ assert item.name
+ assert item.username
diff --git a/tests/integration/test_task.py b/tests/integration/test_task.py
index 14c8f8f9..78c3880b 100644
--- a/tests/integration/test_task.py
+++ b/tests/integration/test_task.py
@@ -2,11 +2,12 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from datetime import timedelta
from typing import TYPE_CHECKING
-from ._utils import get_random_resource_name, maybe_await
-from apify_client._models import Actor, ListOfRuns, ListOfTasks, ListOfWebhooks, Run, Task
+from .._utils import collect_iterate_until_present, get_random_resource_name, maybe_await
+from apify_client._models import Actor, ListOfRuns, ListOfTasks, ListOfWebhooks, Run, RunShort, Task, TaskShort
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
@@ -350,3 +351,125 @@ async def test_task_webhooks(client: ApifyClient | ApifyClientAsync) -> None:
finally:
# Cleanup task
await maybe_await(task_client.delete())
+
+
+async def test_task_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user tasks."""
+ actor = await maybe_await(client.actor(HELLO_WORLD_ACTOR).get())
+ assert isinstance(actor, Actor)
+
+ created_ids: list[str] = []
+ for _ in range(3):
+ task = await maybe_await(client.tasks().create(actor_id=actor.id, name=get_random_resource_name('task')))
+ assert isinstance(task, Task)
+ created_ids.append(task.id)
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.tasks().iterate(desc=True),
+ set(created_ids),
+ item_type=TaskShort,
+ is_async=is_async,
+ )
+ collected_ids = {t.id for t in collected}
+ for task_id in created_ids:
+ assert task_id in collected_ids
+ finally:
+ for task_id in created_ids:
+ await maybe_await(client.task(task_id).delete())
+
+
+async def test_task_start_with_input_override(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test starting a task with run input that overrides the saved input."""
+ actor = await maybe_await(client.actor(HELLO_WORLD_ACTOR).get())
+ assert isinstance(actor, Actor)
+
+ task_name = get_random_resource_name('task')
+ created_task = await maybe_await(
+ client.tasks().create(
+ actor_id=actor.id,
+ name=task_name,
+ task_input={'message': 'original'},
+ )
+ )
+ assert isinstance(created_task, Task)
+ task_client = client.task(created_task.id)
+
+ try:
+ run = await maybe_await(task_client.start(task_input={'message': 'overridden'}, memory_mbytes=256))
+ assert isinstance(run, Run)
+
+ # Wait and clean up
+ await maybe_await(client.run(run.id).wait_for_finish())
+ await maybe_await(client.run(run.id).delete())
+ finally:
+ await maybe_await(task_client.delete())
+
+
+async def test_task_call_with_build_override(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test calling a task with explicit build/memory overrides."""
+ actor = await maybe_await(client.actor(HELLO_WORLD_ACTOR).get())
+ assert isinstance(actor, Actor)
+
+ task_name = get_random_resource_name('task')
+ created_task = await maybe_await(client.tasks().create(actor_id=actor.id, name=task_name))
+ assert isinstance(created_task, Task)
+ task_client = client.task(created_task.id)
+
+ try:
+ run = await maybe_await(
+ task_client.call(
+ build='latest',
+ memory_mbytes=256,
+ run_timeout=timedelta(seconds=120),
+ )
+ )
+ assert isinstance(run, Run)
+ assert run.status == 'SUCCEEDED'
+ assert run.options is not None
+ assert run.options.memory_mbytes == 256
+
+ await maybe_await(client.run(run.id).delete())
+ finally:
+ await maybe_await(task_client.delete())
+
+
+async def test_task_runs_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over a task's runs."""
+ actor = await maybe_await(client.actor(HELLO_WORLD_ACTOR).get())
+ assert isinstance(actor, Actor)
+
+ task_name = get_random_resource_name('task')
+ created_task = await maybe_await(client.tasks().create(actor_id=actor.id, name=task_name))
+ assert isinstance(created_task, Task)
+ task_client = client.task(created_task.id)
+
+ try:
+ run = await maybe_await(task_client.call())
+ assert isinstance(run, Run)
+
+ iterator = task_client.runs().iterate(limit=5)
+ collected: list[RunShort] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for r in iterator:
+ assert isinstance(r, RunShort)
+ collected.append(r)
+ else:
+ assert isinstance(iterator, Iterator)
+ for r in iterator:
+ assert isinstance(r, RunShort)
+ collected.append(r)
+
+ run_ids = [r.id for r in collected]
+ assert run.id in run_ids
+
+ await maybe_await(client.run(run.id).delete())
+ finally:
+ await maybe_await(task_client.delete())
+
+
+async def test_task_get_nonexistent_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that get() on a non-existent task returns None."""
+ task = await maybe_await(client.task('NoNeXiStEnTtAsK1').get())
+ assert task is None
diff --git a/tests/integration/test_user.py b/tests/integration/test_user.py
index 5abde190..1abd9a78 100644
--- a/tests/integration/test_user.py
+++ b/tests/integration/test_user.py
@@ -4,7 +4,7 @@
from typing import TYPE_CHECKING
-from ._utils import maybe_await
+from .._utils import maybe_await
from apify_client._models import AccountLimits, MonthlyUsage, UserPrivateInfo, UserPublicInfo
from apify_client.errors import ApifyApiError
diff --git a/tests/integration/test_webhook.py b/tests/integration/test_webhook.py
index 31e99a30..35fd30e0 100644
--- a/tests/integration/test_webhook.py
+++ b/tests/integration/test_webhook.py
@@ -2,13 +2,14 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
-from ._utils import maybe_await
+from .._utils import collect_iterate_until_present, maybe_await
from apify_client._models import (
ListOfRuns,
ListOfWebhookDispatches,
@@ -16,6 +17,7 @@
Run,
Webhook,
WebhookDispatch,
+ WebhookShort,
)
HELLO_WORLD_ACTOR = 'apify/hello-world'
@@ -193,3 +195,84 @@ async def test_webhook_delete(client: ApifyClient | ApifyClientAsync) -> None:
# Verify it's gone
retrieved_webhook = await maybe_await(webhook_client.get())
assert retrieved_webhook is None
+
+
+async def test_webhook_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over user webhooks."""
+ run_id = await _get_finished_run_id(client)
+
+ created_ids: list[str] = []
+ # Use distinct request URLs so the API does not dedupe webhooks by (event_types, run_id, url)
+ for i in range(3):
+ webhook = await maybe_await(
+ client.webhooks().create(
+ event_types=['ACTOR.RUN.SUCCEEDED'],
+ request_url=f'https://httpbin.org/post?n={i}',
+ actor_run_id=run_id,
+ is_ad_hoc=True,
+ )
+ )
+ assert isinstance(webhook, Webhook)
+ created_ids.append(webhook.id)
+
+ # The API must return 3 distinct webhooks - otherwise dedup happened
+ assert len(set(created_ids)) == 3
+
+ try:
+ collected = await collect_iterate_until_present(
+ lambda: client.webhooks().iterate(desc=True),
+ set(created_ids),
+ item_type=WebhookShort,
+ is_async=is_async,
+ )
+ collected_ids = {w.id for w in collected}
+ for webhook_id in created_ids:
+ assert webhook_id in collected_ids
+ finally:
+ for webhook_id in created_ids:
+ await maybe_await(client.webhook(webhook_id).delete())
+
+
+async def test_webhook_get_nonexistent_returns_none(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test that get() on a non-existent webhook returns None."""
+ webhook = await maybe_await(client.webhook('NoNeXiStEnTwH').get())
+ assert webhook is None
+
+
+async def test_webhook_dispatches_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over a webhook's dispatches."""
+ run_id = await _get_finished_run_id(client)
+
+ created_webhook = await maybe_await(
+ client.webhooks().create(
+ event_types=['ACTOR.RUN.SUCCEEDED'],
+ request_url='https://httpbin.org/post',
+ actor_run_id=run_id,
+ is_ad_hoc=True,
+ )
+ )
+ assert isinstance(created_webhook, Webhook)
+ webhook_client = client.webhook(created_webhook.id)
+
+ try:
+ # Generate at least one dispatch by hitting the test endpoint
+ await maybe_await(webhook_client.test())
+
+ iterator = webhook_client.dispatches().iterate(limit=10)
+ collected: list[WebhookDispatch] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for d in iterator:
+ assert isinstance(d, WebhookDispatch)
+ collected.append(d)
+ else:
+ assert isinstance(iterator, Iterator)
+ for d in iterator:
+ assert isinstance(d, WebhookDispatch)
+ collected.append(d)
+
+ assert len(collected) >= 1
+ for dispatch in collected:
+ assert dispatch.id is not None
+ finally:
+ await maybe_await(webhook_client.delete())
diff --git a/tests/integration/test_webhook_dispatch.py b/tests/integration/test_webhook_dispatch.py
index fbfcf5e2..5ac7b919 100644
--- a/tests/integration/test_webhook_dispatch.py
+++ b/tests/integration/test_webhook_dispatch.py
@@ -2,9 +2,10 @@
from __future__ import annotations
+from collections.abc import AsyncIterator, Iterator
from typing import TYPE_CHECKING
-from ._utils import maybe_await
+from .._utils import maybe_await
from apify_client._models import ListOfWebhookDispatches, WebhookDispatch
if TYPE_CHECKING:
@@ -36,3 +37,45 @@ async def test_webhook_dispatch_get(client: ApifyClient | ApifyClientAsync) -> N
# If no dispatches, test that get returns None for non-existent ID
dispatch = await maybe_await(client.webhook_dispatch('non-existent-id').get())
assert dispatch is None
+
+
+async def test_webhook_dispatch_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
+ """Test paginated iteration over the user's webhook dispatches."""
+ iterator = client.webhook_dispatches().iterate(limit=5)
+ collected: list[WebhookDispatch] = []
+ if is_async:
+ assert isinstance(iterator, AsyncIterator)
+ async for d in iterator:
+ assert isinstance(d, WebhookDispatch)
+ collected.append(d)
+ else:
+ assert isinstance(iterator, Iterator)
+ for d in iterator:
+ assert isinstance(d, WebhookDispatch)
+ collected.append(d)
+
+ assert len(collected) <= 5
+ for dispatch in collected:
+ assert dispatch.id is not None
+
+
+async def test_webhook_dispatch_list_pagination(client: ApifyClient | ApifyClientAsync) -> None:
+ """Test webhook_dispatches().list() with pagination parameters."""
+ page = await maybe_await(client.webhook_dispatches().list(limit=5, offset=0, desc=True))
+ assert isinstance(page, ListOfWebhookDispatches)
+ assert isinstance(page.items, list)
+ # `limit=5` must cap the page size.
+ assert len(page.items) <= 5
+ # `desc=True` must return dispatches in non-increasing `created_at` order.
+ created_ats = [d.created_at for d in page.items if d.created_at is not None]
+ assert created_ats == sorted(created_ats, reverse=True)
+ # `offset` must move the window — the second page must not start with the same id as the first.
+ # Use ascending order so dispatches created by parallel tests can't shift the pages between calls.
+ asc_page = await maybe_await(client.webhook_dispatches().list(limit=5, offset=0, desc=False))
+ assert isinstance(asc_page, ListOfWebhookDispatches)
+ # Only meaningful when the first page is full.
+ if len(asc_page.items) == 5:
+ next_page = await maybe_await(client.webhook_dispatches().list(limit=5, offset=5, desc=False))
+ assert isinstance(next_page, ListOfWebhookDispatches)
+ if next_page.items:
+ assert asc_page.items[0].id != next_page.items[0].id
diff --git a/tests/unit/test_actor_start_params.py b/tests/unit/test_actor_start_params.py
index 6aa447cc..d06adb1f 100644
--- a/tests/unit/test_actor_start_params.py
+++ b/tests/unit/test_actor_start_params.py
@@ -64,7 +64,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
@@ -97,7 +97,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
@@ -130,7 +130,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
@@ -160,7 +160,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
@@ -191,7 +191,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
@@ -218,7 +218,7 @@ def capture_request(request: Request) -> Response:
)
httpserver.expect_request(
- f'/v2/acts/{_MOCKED_ACTOR_ID}/runs',
+ f'/v2/actors/{_MOCKED_ACTOR_ID}/runs',
method='POST',
).respond_with_handler(capture_request)
diff --git a/tests/unit/test_client_errors.py b/tests/unit/test_client_errors.py
index 4dae2168..fc3b63ab 100644
--- a/tests/unit/test_client_errors.py
+++ b/tests/unit/test_client_errors.py
@@ -281,7 +281,7 @@ def test_actor_last_run_dataset_get_raises_on_404(httpserver: HTTPServer, sync_c
"""404 covers missing actor, missing last_run, or missing dataset — all three are indistinguishable from the single
HTTP response (the client only hits the final URL), so `NotFoundError` propagates uniformly.
"""
- httpserver.expect_request('/v2/acts/actor-id/runs/last/dataset').respond_with_json(_not_found_body(), status=404)
+ httpserver.expect_request('/v2/actors/actor-id/runs/last/dataset').respond_with_json(_not_found_body(), status=404)
with pytest.raises(NotFoundError):
sync_client.actor('actor-id').last_run().dataset().get()
@@ -289,13 +289,13 @@ def test_actor_last_run_dataset_get_raises_on_404(httpserver: HTTPServer, sync_c
async def test_actor_last_run_dataset_get_raises_on_404_async(
httpserver: HTTPServer, async_client: ApifyClientAsync
) -> None:
- httpserver.expect_request('/v2/acts/actor-id/runs/last/dataset').respond_with_json(_not_found_body(), status=404)
+ httpserver.expect_request('/v2/actors/actor-id/runs/last/dataset').respond_with_json(_not_found_body(), status=404)
with pytest.raises(NotFoundError):
await async_client.actor('actor-id').last_run().dataset().get()
def test_actor_last_run_dataset_get_returns_dataset(httpserver: HTTPServer, sync_client: ApifyClient) -> None:
- httpserver.expect_request('/v2/acts/actor-id/runs/last/dataset').respond_with_json({'data': _DATASET_FIXTURE})
+ httpserver.expect_request('/v2/actors/actor-id/runs/last/dataset').respond_with_json({'data': _DATASET_FIXTURE})
dataset = sync_client.actor('actor-id').last_run().dataset().get()
assert dataset is not None
assert dataset.id == 'ds-1'
@@ -304,7 +304,7 @@ def test_actor_last_run_dataset_get_returns_dataset(httpserver: HTTPServer, sync
async def test_actor_last_run_dataset_get_returns_dataset_async(
httpserver: HTTPServer, async_client: ApifyClientAsync
) -> None:
- httpserver.expect_request('/v2/acts/actor-id/runs/last/dataset').respond_with_json({'data': _DATASET_FIXTURE})
+ httpserver.expect_request('/v2/actors/actor-id/runs/last/dataset').respond_with_json({'data': _DATASET_FIXTURE})
dataset = await async_client.actor('actor-id').last_run().dataset().get()
assert dataset is not None
assert dataset.id == 'ds-1'
diff --git a/tests/unit/test_logging.py b/tests/unit/test_logging.py
index 62139e67..9fe56fa3 100644
--- a/tests/unit/test_logging.py
+++ b/tests/unit/test_logging.py
@@ -3,6 +3,7 @@
import asyncio
import json
import logging
+import threading
import time
from datetime import datetime, timedelta
from typing import TYPE_CHECKING
@@ -14,7 +15,7 @@
from apify_client import ApifyClient, ApifyClientAsync
from apify_client._logging import RedirectLogFormatter
from apify_client._status_message_watcher import StatusMessageWatcherBase
-from apify_client._streamed_log import StreamedLogBase
+from apify_client._streamed_log import StreamedLog, StreamedLogBase
if TYPE_CHECKING:
from collections.abc import Iterator
@@ -170,7 +171,7 @@ def mock_api(httpserver: HTTPServer) -> None:
)
# Add actor info endpoint
- httpserver.expect_request(f'/v2/acts/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
+ httpserver.expect_request(f'/v2/actors/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
{
'data': {
'id': _MOCKED_ACTOR_ID,
@@ -202,7 +203,7 @@ def mock_api(httpserver: HTTPServer) -> None:
)
# Add actor run creation endpoint
- httpserver.expect_request(f'/v2/acts/{_MOCKED_ACTOR_ID}/runs', method='POST').respond_with_json(
+ httpserver.expect_request(f'/v2/actors/{_MOCKED_ACTOR_ID}/runs', method='POST').respond_with_json(
{
'data': status_generator._create_minimal_run_data('Initial message', 'RUNNING', is_terminal=False),
}
@@ -519,7 +520,7 @@ async def test_streamed_log_async_restart_after_normal_completion(httpserver: HT
)
# Set up actor info endpoint
- httpserver.expect_request(f'/v2/acts/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
+ httpserver.expect_request(f'/v2/actors/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
{
'data': {
'id': _MOCKED_ACTOR_ID,
@@ -607,7 +608,7 @@ async def test_status_message_watcher_async_restart_after_normal_completion(http
)
# Set up actor info endpoint (needed for get_status_message_watcher)
- httpserver.expect_request(f'/v2/acts/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
+ httpserver.expect_request(f'/v2/actors/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
{
'data': {
'id': _MOCKED_ACTOR_ID,
@@ -716,3 +717,146 @@ async def test_async_watcher_aexit_skips_final_sleep_on_exception(
elapsed = time.monotonic() - start
assert elapsed < _FAST_EXIT_THRESHOLD_S, f'__aexit__ should skip final sleep on exception, took {elapsed:.2f}s'
+
+
+_TAIL_FIRST_MESSAGE = '2025-05-13T07:24:12.588Z tail_test first complete line'
+_TAIL_SECOND_MESSAGE = '2025-05-13T07:24:13.132Z tail_test trailing partial line'
+
+
+def _register_run_and_actor_endpoints(httpserver: HTTPServer) -> None:
+ """Register the minimal run and actor endpoints required by `get_streamed_log`."""
+ httpserver.expect_request(f'/v2/actor-runs/{_MOCKED_RUN_ID}', method='GET').respond_with_json(
+ {
+ 'data': {
+ 'id': _MOCKED_RUN_ID,
+ 'actId': _MOCKED_ACTOR_ID,
+ 'userId': 'test_user_id',
+ 'startedAt': '2019-11-30T07:34:24.202Z',
+ 'finishedAt': '2019-12-12T09:30:12.202Z',
+ 'status': 'RUNNING',
+ 'statusMessage': 'Running',
+ 'isStatusMessageTerminal': False,
+ 'meta': {'origin': 'WEB'},
+ 'stats': {'restartCount': 0, 'resurrectCount': 0, 'computeUnits': 0.1},
+ 'options': {'build': 'latest', 'timeoutSecs': 300, 'memoryMbytes': 1024, 'diskMbytes': 2048},
+ 'buildId': 'test_build_id',
+ 'generalAccess': 'RESTRICTED',
+ 'defaultKeyValueStoreId': 'test_kvs_id',
+ 'defaultDatasetId': 'test_dataset_id',
+ 'defaultRequestQueueId': 'test_rq_id',
+ 'buildNumber': '0.0.1',
+ 'containerUrl': 'https://test.runs.apify.net',
+ }
+ }
+ )
+ httpserver.expect_request(f'/v2/actors/{_MOCKED_ACTOR_ID}', method='GET').respond_with_json(
+ {
+ 'data': {
+ 'id': _MOCKED_ACTOR_ID,
+ 'userId': 'test_user_id',
+ 'name': _MOCKED_ACTOR_NAME,
+ 'username': 'test_user',
+ 'isPublic': False,
+ 'createdAt': '2019-07-08T11:27:57.401Z',
+ 'modifiedAt': '2019-07-08T14:01:05.546Z',
+ 'stats': {
+ 'totalBuilds': 0,
+ 'totalRuns': 0,
+ 'totalUsers': 0,
+ 'totalUsers7Days': 0,
+ 'totalUsers30Days': 0,
+ 'totalUsers90Days': 0,
+ 'totalMetamorphs': 0,
+ 'lastRunStartedAt': '2019-07-08T14:01:05.546Z',
+ },
+ 'versions': [],
+ 'defaultRunOptions': {'build': 'latest', 'timeoutSecs': 3600, 'memoryMbytes': 2048},
+ 'deploymentKey': 'test_key',
+ }
+ }
+ )
+
+
+@pytest.mark.usefixtures('propagate_stream_logs')
+async def test_streamed_log_async_stop_flushes_buffered_tail(
+ caplog: LogCaptureFixture,
+ httpserver: HTTPServer,
+) -> None:
+ """Verify the buffered tail is flushed to the logger when the async task is cancelled by `stop`."""
+ stop_emitting = threading.Event()
+
+ def _tail_handler(_request: Request) -> Response:
+ def generate_logs() -> Iterator[bytes]:
+ yield f'{_TAIL_FIRST_MESSAGE}\n'.encode()
+ # Second marker has no trailing newline/next-marker, so it stays in the buffer.
+ yield _TAIL_SECOND_MESSAGE.encode()
+ # Block until the test tears the server down (or stop releases us).
+ stop_emitting.wait(timeout=30)
+
+ return Response(response=generate_logs(), status=200, mimetype='application/octet-stream')
+
+ httpserver.expect_request(
+ f'/v2/actor-runs/{_MOCKED_RUN_ID}/log', method='GET', query_string='stream=true&raw=true'
+ ).respond_with_handler(_tail_handler)
+ _register_run_and_actor_endpoints(httpserver)
+
+ api_url = httpserver.url_for('/').removesuffix('/')
+ run_client = ApifyClientAsync(token='mocked_token', api_url=api_url).run(run_id=_MOCKED_RUN_ID)
+ streamed_log = await run_client.get_streamed_log()
+
+ logger_name = f'apify.{_MOCKED_ACTOR_NAME}-{_MOCKED_RUN_ID}'
+
+ try:
+ with caplog.at_level(logging.DEBUG, logger=logger_name):
+ async with streamed_log:
+ # Wait long enough for both chunks to arrive and be processed.
+ await asyncio.sleep(1)
+ # Context exit calls stop(), which cancels the task mid-stream.
+ finally:
+ stop_emitting.set()
+
+ messages = [record.message for record in caplog.records]
+ assert any(_TAIL_FIRST_MESSAGE in m for m in messages), f'First message missing. Got: {messages}'
+ assert any(_TAIL_SECOND_MESSAGE in m for m in messages), f'Buffered tail dropped on async stop(). Got: {messages}'
+
+
+def test_streamed_log_sync_stop_does_not_hang_on_silent_stream(
+ httpserver: HTTPServer,
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ """Verify `stop()` returns promptly even when the underlying stream is silent (no chunks)."""
+ # Shorten the read timeout so the test doesn't wait for the production default.
+ monkeypatch.setattr(StreamedLog, '_read_timeout', timedelta(seconds=1))
+
+ release_server = threading.Event()
+
+ def _silent_handler(_request: Request) -> Response:
+ def generate_logs() -> Iterator[bytes]:
+ # Yield an empty chunk so werkzeug flushes headers and the client sees a streaming
+ # response; then block without emitting any log data.
+ yield b''
+ release_server.wait(timeout=30)
+
+ return Response(response=generate_logs(), status=200, mimetype='application/octet-stream')
+
+ httpserver.expect_request(
+ f'/v2/actor-runs/{_MOCKED_RUN_ID}/log', method='GET', query_string='stream=true&raw=true'
+ ).respond_with_handler(_silent_handler)
+ _register_run_and_actor_endpoints(httpserver)
+
+ api_url = httpserver.url_for('/').removesuffix('/')
+ run_client = ApifyClient(token='mocked_token', api_url=api_url).run(run_id=_MOCKED_RUN_ID)
+ streamed_log = run_client.get_streamed_log()
+
+ streamed_log.start()
+ try:
+ # Give the streaming thread time to start and block inside iter_bytes.
+ time.sleep(0.3)
+
+ # Call stop() from a helper thread so the test cannot hang indefinitely if the fix regresses.
+ stop_thread = threading.Thread(target=streamed_log.stop)
+ stop_thread.start()
+ stop_thread.join(timeout=5)
+ assert not stop_thread.is_alive(), 'stop() hangs when the underlying stream is silent'
+ finally:
+ release_server.set()
diff --git a/uv.lock b/uv.lock
index fff9aa2c..ddb2d792 100644
--- a/uv.lock
+++ b/uv.lock
@@ -40,7 +40,7 @@ wheels = [
[[package]]
name = "apify-client"
-version = "2.5.1"
+version = "3.0.3"
source = { editable = "." }
dependencies = [
{ name = "colorama" },
diff --git a/website/package.json b/website/package.json
index af8a2c5a..e88f9819 100644
--- a/website/package.json
+++ b/website/package.json
@@ -20,8 +20,8 @@
"preinstall": "npx only-allow pnpm"
},
"dependencies": {
- "@apify/docs-theme": "^1.0.249",
- "@apify/docusaurus-plugin-typedoc-api": "^5.1.6",
+ "@apify/docs-theme": "^1.0.251",
+ "@apify/docusaurus-plugin-typedoc-api": "^5.1.7",
"@docusaurus/core": "^3.8.1",
"@docusaurus/faster": "^3.8.1",
"@docusaurus/plugin-client-redirects": "^3.8.1",
@@ -49,5 +49,5 @@
"rimraf": "^6.0.0",
"typescript": "^6.0.0"
},
- "packageManager": "pnpm@10.24.0"
+ "packageManager": "pnpm@11.5.1"
}
diff --git a/website/pnpm-lock.yaml b/website/pnpm-lock.yaml
index 41ce9784..4b0c231d 100644
--- a/website/pnpm-lock.yaml
+++ b/website/pnpm-lock.yaml
@@ -9,11 +9,11 @@ importers:
.:
dependencies:
'@apify/docs-theme':
- specifier: ^1.0.249
- version: 1.0.249(@algolia/client-search@5.50.1)(@babel/core@7.29.0)(@docusaurus/plugin-content-docs@3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2))(@rspack/core@1.7.11)(@swc/core@1.15.24)(@types/react@19.2.14)(clsx@2.1.1)(postcss@8.5.14)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5)(search-insights@2.17.3)(styled-components@5.3.11(@babel/core@7.29.0)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5))(webpack@5.106.1(@swc/core@1.15.24))
+ specifier: ^1.0.251
+ version: 1.0.251(@algolia/client-search@5.50.1)(@babel/core@7.29.0)(@docusaurus/plugin-content-docs@3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2))(@rspack/core@1.7.11)(@swc/core@1.15.24)(@types/react@19.2.14)(clsx@2.1.1)(postcss@8.5.14)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5)(search-insights@2.17.3)(styled-components@5.3.11(@babel/core@7.29.0)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5))(webpack@5.106.1(@swc/core@1.15.24))
'@apify/docusaurus-plugin-typedoc-api':
- specifier: ^5.1.6
- version: 5.1.6(b5d850f32c50aa67ed4d2687a57dffc8)
+ specifier: ^5.1.7
+ version: 5.1.7(b5d850f32c50aa67ed4d2687a57dffc8)
'@docusaurus/core':
specifier: ^3.8.1
version: 3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2)
@@ -243,15 +243,15 @@ packages:
react: '> 18.0.0'
react-dom: '> 18.0.0'
- '@apify/docs-theme@1.0.249':
- resolution: {integrity: sha512-Oo9SGx7bHVmsWexO8n8Laq3TFee81gV2vOk09EaHE6cIcLP9OKjDBe4/6Gusxv5CGm9k/axVTS13fA1lETaP6A==}
+ '@apify/docs-theme@1.0.251':
+ resolution: {integrity: sha512-zfz9BrjeK8NR5FuIm1B573mI3quhHDI+zlveZNfkEr++9c3ZBrecEDOCbqAHP/ZTq1BJ9UW93r/kfC4KPEgriw==}
peerDependencies:
clsx: '*'
react: '*'
react-dom: '*'
- '@apify/docusaurus-plugin-typedoc-api@5.1.6':
- resolution: {integrity: sha512-qBjozPWltxMNyrH8GSM6V7KNTNc17KGcAOn8Z9RZftRH5SRhn/PKn/ENRAwjW8kpxT+0vEQAf+n32W/G7diZ8A==}
+ '@apify/docusaurus-plugin-typedoc-api@5.1.7':
+ resolution: {integrity: sha512-W70ZTzwDxcY1PUu6jRF+OfHG4zk3lgBsXjjMm9+2SS9tZH8Ajj/musVq/+4DQdFrWXBNvtq3vqkZnA4B1Idd3Q==}
engines: {node: '>=16.12.0'}
peerDependencies:
'@docusaurus/core': ^3.8.1
@@ -624,8 +624,8 @@ packages:
peerDependencies:
'@babel/core': ^7.0.0-0
- '@babel/plugin-transform-modules-systemjs@7.29.0':
- resolution: {integrity: sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==}
+ '@babel/plugin-transform-modules-systemjs@7.29.4':
+ resolution: {integrity: sha512-N7QmZ0xRZfjHOfZeQLJjwgX2zS9pdGHSVl/cjSGlo4dXMqvurfxXDMKY4RqEKzPozV78VMcd0lxyG13mlbKc4w==}
engines: {node: '>=6.9.0'}
peerDependencies:
'@babel/core': ^7.0.0-0
@@ -849,6 +849,10 @@ packages:
resolution: {integrity: sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==}
engines: {node: '>=6.9.0'}
+ '@babel/runtime@7.29.7':
+ resolution: {integrity: sha512-Nq8OhGWiZIZGV6hLHoyAKLLcJihP/xFeBMGJoUrxTX2psI8dCifzLhZISFb+VWS3wFMRDmCGw5R+dOySCqPLhw==}
+ engines: {node: '>=6.9.0'}
+
'@babel/template@7.28.6':
resolution: {integrity: sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==}
engines: {node: '>=6.9.0'}
@@ -3281,8 +3285,8 @@ packages:
resolution: {integrity: sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==}
engines: {node: '>=8'}
- body-parser@1.20.4:
- resolution: {integrity: sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==}
+ body-parser@1.20.5:
+ resolution: {integrity: sha512-3grm+/2tUOvu2cjJkvsIxrv/wVpfXQW4PsQHYm7yk4vfpu7Ekl6nEsYBoJUL6qDwZUx8wUhQ8tR2qz+ad9c9OA==}
engines: {node: '>= 0.8', npm: 1.2.8000 || >= 1.4.16}
bonjour-service@1.3.0:
@@ -4247,8 +4251,8 @@ packages:
resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==}
engines: {node: '>=10'}
- express@4.22.1:
- resolution: {integrity: sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==}
+ express@4.22.2:
+ resolution: {integrity: sha512-IuL+Elrou2ZvCFHs18/CIzy2Nzvo25nZ1/D2eIZlz7c+QUayAcYoiM2BthCjs+EBHVpjYjcuLDAiCWgeIX3X1Q==}
engines: {node: '>= 0.10.0'}
extend-shallow@2.0.1:
@@ -4275,8 +4279,8 @@ packages:
fast-levenshtein@2.0.6:
resolution: {integrity: sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==}
- fast-uri@3.1.0:
- resolution: {integrity: sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==}
+ fast-uri@3.1.2:
+ resolution: {integrity: sha512-rVjf7ArG3LTk+FS6Yw81V1DLuZl1bRbNrev6Tmd/9RaroeeRRJhAt7jg/6YFxbvAQXUCavSoZhPPj6oOx+5KjQ==}
fastq@1.20.1:
resolution: {integrity: sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==}
@@ -6463,8 +6467,8 @@ packages:
resolution: {integrity: sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA==}
engines: {node: '>=16.0.0'}
- qs@6.14.2:
- resolution: {integrity: sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==}
+ qs@6.15.2:
+ resolution: {integrity: sha512-Rzq0KEyX/w/tEybncDgdkZrJgVUsUMk3xjh3t5bv3S1HTAtg+uOYt72+ZfwiQwKdysThkTBdL/rTi6HDmX9Ddw==}
engines: {node: '>=0.6'}
query-string@8.2.0:
@@ -7897,7 +7901,7 @@ snapshots:
- search-insights
- supports-color
- '@apify/docs-theme@1.0.249(@algolia/client-search@5.50.1)(@babel/core@7.29.0)(@docusaurus/plugin-content-docs@3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2))(@rspack/core@1.7.11)(@swc/core@1.15.24)(@types/react@19.2.14)(clsx@2.1.1)(postcss@8.5.14)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5)(search-insights@2.17.3)(styled-components@5.3.11(@babel/core@7.29.0)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5))(webpack@5.106.1(@swc/core@1.15.24))':
+ '@apify/docs-theme@1.0.251(@algolia/client-search@5.50.1)(@babel/core@7.29.0)(@docusaurus/plugin-content-docs@3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2))(@rspack/core@1.7.11)(@swc/core@1.15.24)(@types/react@19.2.14)(clsx@2.1.1)(postcss@8.5.14)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5)(search-insights@2.17.3)(styled-components@5.3.11(@babel/core@7.29.0)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5))(webpack@5.106.1(@swc/core@1.15.24))':
dependencies:
'@apify/docs-search-modal': 1.3.6(@algolia/client-search@5.50.1)(@babel/core@7.29.0)(@types/react@19.2.14)(react-dom@19.2.5(react@19.2.5))(react-is@16.13.1)(react@19.2.5)(search-insights@2.17.3)
'@apify/ui-icons': 1.34.1(react-dom@19.2.5(react@19.2.5))(react@19.2.5)
@@ -7936,7 +7940,7 @@ snapshots:
- webpack
- webpack-cli
- '@apify/docusaurus-plugin-typedoc-api@5.1.6(b5d850f32c50aa67ed4d2687a57dffc8)':
+ '@apify/docusaurus-plugin-typedoc-api@5.1.7(b5d850f32c50aa67ed4d2687a57dffc8)':
dependencies:
'@docusaurus/core': 3.10.0(@docusaurus/faster@3.10.0(@docusaurus/types@3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)))(@mdx-js/react@3.1.1(@types/react@19.2.14)(react@19.2.5))(@rspack/core@1.7.11)(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)(typescript@6.0.2)
'@docusaurus/mdx-loader': 3.10.0(@swc/core@1.15.24)(react-dom@19.2.5(react@19.2.5))(react@19.2.5)
@@ -8426,7 +8430,7 @@ snapshots:
transitivePeerDependencies:
- supports-color
- '@babel/plugin-transform-modules-systemjs@7.29.0(@babel/core@7.29.0)':
+ '@babel/plugin-transform-modules-systemjs@7.29.4(@babel/core@7.29.0)':
dependencies:
'@babel/core': 7.29.0
'@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0)
@@ -8689,7 +8693,7 @@ snapshots:
'@babel/plugin-transform-member-expression-literals': 7.27.1(@babel/core@7.29.0)
'@babel/plugin-transform-modules-amd': 7.27.1(@babel/core@7.29.0)
'@babel/plugin-transform-modules-commonjs': 7.28.6(@babel/core@7.29.0)
- '@babel/plugin-transform-modules-systemjs': 7.29.0(@babel/core@7.29.0)
+ '@babel/plugin-transform-modules-systemjs': 7.29.4(@babel/core@7.29.0)
'@babel/plugin-transform-modules-umd': 7.27.1(@babel/core@7.29.0)
'@babel/plugin-transform-named-capturing-groups-regex': 7.29.0(@babel/core@7.29.0)
'@babel/plugin-transform-new-target': 7.27.1(@babel/core@7.29.0)
@@ -8756,6 +8760,8 @@ snapshots:
'@babel/runtime@7.29.2': {}
+ '@babel/runtime@7.29.7': {}
+
'@babel/template@7.28.6':
dependencies:
'@babel/code-frame': 7.29.0
@@ -11020,7 +11026,7 @@ snapshots:
'@slorber/react-helmet-async@1.3.0(react-dom@19.2.5(react@19.2.5))(react@19.2.5)':
dependencies:
- '@babel/runtime': 7.29.2
+ '@babel/runtime': 7.29.7
invariant: 2.2.4
prop-types: 15.8.1
react: 19.2.5
@@ -11714,7 +11720,7 @@ snapshots:
ajv@8.18.0:
dependencies:
fast-deep-equal: 3.1.3
- fast-uri: 3.1.0
+ fast-uri: 3.1.2
json-schema-traverse: 1.0.0
require-from-string: 2.0.2
@@ -11978,7 +11984,7 @@ snapshots:
binary-extensions@2.3.0: {}
- body-parser@1.20.4:
+ body-parser@1.20.5:
dependencies:
bytes: 3.1.2
content-type: 1.0.5
@@ -11988,7 +11994,7 @@ snapshots:
http-errors: 2.0.1
iconv-lite: 0.4.24
on-finished: 2.4.1
- qs: 6.14.2
+ qs: 6.15.2
raw-body: 2.5.3
type-is: 1.6.18
unpipe: 1.0.0
@@ -13172,11 +13178,11 @@ snapshots:
signal-exit: 3.0.7
strip-final-newline: 2.0.0
- express@4.22.1:
+ express@4.22.2:
dependencies:
accepts: 1.3.8
array-flatten: 1.1.1
- body-parser: 1.20.4
+ body-parser: 1.20.5
content-disposition: 0.5.4
content-type: 1.0.5
cookie: 0.7.2
@@ -13195,7 +13201,7 @@ snapshots:
parseurl: 1.3.3
path-to-regexp: 0.1.13
proxy-addr: 2.0.7
- qs: 6.14.2
+ qs: 6.15.2
range-parser: 1.2.1
safe-buffer: 5.2.1
send: 0.19.2
@@ -13230,7 +13236,7 @@ snapshots:
fast-levenshtein@2.0.6: {}
- fast-uri@3.1.0: {}
+ fast-uri@3.1.2: {}
fastq@1.20.1:
dependencies:
@@ -15935,7 +15941,7 @@ snapshots:
pvutils@1.1.5: {}
- qs@6.14.2:
+ qs@6.15.2:
dependencies:
side-channel: 1.1.0
@@ -17200,7 +17206,7 @@ snapshots:
colorette: 2.0.20
compression: 1.8.1
connect-history-api-fallback: 2.0.0
- express: 4.22.1
+ express: 4.22.2
graceful-fs: 4.2.11
http-proxy-middleware: 2.0.9(@types/express@4.17.25)
ipaddr.js: 2.3.0
diff --git a/website/pnpm-workspace.yaml b/website/pnpm-workspace.yaml
index a99d0adf..01ab34b4 100644
--- a/website/pnpm-workspace.yaml
+++ b/website/pnpm-workspace.yaml
@@ -8,3 +8,8 @@ linkWorkspacePackages: true
preferWorkspacePackages: true
publicHoistPattern:
- "*"
+allowBuilds:
+ '@apify/ui-icons': true
+ '@swc/core': true
+ core-js: false
+ unrs-resolver: true
diff --git a/website/versioned_docs/version-2.5/01_introduction/index.mdx b/website/versioned_docs/version-2.5/01_introduction/index.mdx
index f4bb1ab1..3786b6a4 100644
--- a/website/versioned_docs/version-2.5/01_introduction/index.mdx
+++ b/website/versioned_docs/version-2.5/01_introduction/index.mdx
@@ -13,11 +13,11 @@ import CodeBlock from '@theme/CodeBlock';
import UsageAsyncExample from '!!raw-loader!./code/01_usage_async.py';
import UsageSyncExample from '!!raw-loader!./code/01_usage_sync.py';
-The Apify API client for Python is the official library to access the [Apify REST API](/api/v2) from your Python applications. It provides useful features like automatic retries and convenience functions that improve the experience of using the Apify API.
+The Apify API client for Python 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.
The client simplifies interaction with the Apify platform by providing:
-- Intuitive methods for working with [Actors](/platform/actors), [datasets](/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and other Apify resources
+- Intuitive methods for working with [Actors](https://docs.apify.com/platform/actors), [Datasets](https://docs.apify.com/platform/storage/dataset), [Key-value stores](https://docs.apify.com/platform/storage/key-value-store), and other Apify resources
- Both synchronous and asynchronous interfaces for flexible integration
- Built-in [retries with exponential backoff](../02_concepts/05_retries.mdx) for failed requests
- Comprehensive API coverage with JSON encoding (UTF-8) for all requests and responses
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py
new file mode 100644
index 00000000..4a45b1e2
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py
@@ -0,0 +1,21 @@
+from apify_client import ApifyClientAsync
+
+# You can find your API token at https://console.apify.com/settings/integrations.
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # Start an Actor and wait for it to finish.
+ actor_client = apify_client.actor('john-doe/my-cool-actor')
+ call_result = await actor_client.call()
+
+ if call_result is None:
+ print('Actor run failed.')
+ return
+
+ # Fetch results from the Actor run's default dataset.
+ dataset_client = apify_client.dataset(call_result.default_dataset_id)
+ list_items_result = await dataset_client.list_items()
+ print(f'Dataset: {list_items_result}')
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py
new file mode 100644
index 00000000..84e430fa
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py
@@ -0,0 +1,21 @@
+from apify_client import ApifyClient
+
+# You can find your API token at https://console.apify.com/settings/integrations.
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # Start an Actor and wait for it to finish.
+ actor_client = apify_client.actor('john-doe/my-cool-actor')
+ call_result = actor_client.call()
+
+ if call_result is None:
+ print('Actor run failed.')
+ return
+
+ # Fetch results from the Actor run's default dataset.
+ dataset_client = apify_client.dataset(call_result.default_dataset_id)
+ list_items_result = dataset_client.list_items()
+ print(f'Dataset: {list_items_result}')
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py
new file mode 100644
index 00000000..a584ccba
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py
@@ -0,0 +1,8 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ # Client initialization with the API token.
+ apify_client = ApifyClientAsync(TOKEN)
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py
new file mode 100644
index 00000000..a5f4de39
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py
@@ -0,0 +1,8 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ # Client initialization with the API token.
+ apify_client = ApifyClient(TOKEN)
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py
new file mode 100644
index 00000000..99541d2a
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py
@@ -0,0 +1,11 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Lists items from the Actor's dataset.
+ dataset_items = (await dataset_client.list_items()).items
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py
new file mode 100644
index 00000000..3cc7554d
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py
@@ -0,0 +1,11 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Lists items from the Actor's dataset.
+ dataset_items = dataset_client.list_items().items
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py b/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py
new file mode 100644
index 00000000..1937f446
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Define the input for the Actor.
+ run_input = {
+ 'some': 'input',
+ }
+
+ # Start an Actor and wait for it to finish.
+ call_result = await actor_client.call(run_input=run_input)
diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py
new file mode 100644
index 00000000..6a27dd39
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Define the input for the Actor.
+ run_input = {
+ 'some': 'input',
+ }
+
+ # Start an Actor and wait for it to finish.
+ call_result = actor_client.call(run_input=run_input)
diff --git a/website/versioned_docs/version-3.0/01_introduction/index.mdx b/website/versioned_docs/version-3.0/01_introduction/index.mdx
new file mode 100644
index 00000000..59a04977
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/index.mdx
@@ -0,0 +1,57 @@
+---
+id: introduction
+title: Overview
+slug: /
+description: The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import UsageAsyncExample from '!!raw-loader!./code/01_usage_async.py';
+import UsageSyncExample from '!!raw-loader!./code/01_usage_sync.py';
+
+The Apify API client for Python is the official library to access the [Apify REST API](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.
+
+The client simplifies interaction with the Apify platform by providing:
+
+- Intuitive methods for working with [Actors](https://docs.apify.com/platform/actors), [Datasets](https://docs.apify.com/platform/storage/dataset), [Key-value stores](https://docs.apify.com/platform/storage/key-value-store), and other Apify resources
+- Both synchronous and asynchronous interfaces for flexible integration
+- Built-in [retries with exponential backoff](../02_concepts/05_retries.mdx) for failed requests
+- Comprehensive API coverage with JSON encoding (UTF-8) for all requests and responses
+
+## Prerequisites
+
+`apify-client` requires Python 3.11 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running:
+
+```bash
+python --version
+```
+
+## Installation
+
+The Apify client is available as the [`apify-client`](https://pypi.org/project/apify-client/) package on PyPI.
+
+```bash
+pip install apify-client
+```
+
+## Quick example
+
+The following example shows how to run an Actor and retrieve its results:
+
+
+
+
+ {UsageAsyncExample}
+
+
+
+
+ {UsageSyncExample}
+
+
+
+
+> You can find your API token in the [Integrations section](https://console.apify.com/account/integrations) of Apify Console. See the [Quick start guide](./quick-start.mdx) for more details on authentication.
diff --git a/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx b/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx
new file mode 100644
index 00000000..7083c16c
--- /dev/null
+++ b/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx
@@ -0,0 +1,107 @@
+---
+id: quick-start
+title: Quick start
+description: Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import AuthAsyncExample from '!!raw-loader!./code/02_auth_async.py';
+import AuthSyncExample from '!!raw-loader!./code/02_auth_sync.py';
+import InputAsyncExample from '!!raw-loader!./code/03_input_async.py';
+import InputSyncExample from '!!raw-loader!./code/03_input_sync.py';
+import DatasetAsyncExample from '!!raw-loader!./code/03_dataset_async.py';
+import DatasetSyncExample from '!!raw-loader!./code/03_dataset_sync.py';
+
+Learn how to authenticate, run Actors, and retrieve results using the Apify API client for Python.
+
+---
+
+## Step 1: Authenticate the client
+
+To use the client, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token under the [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing it (`MY-APIFY-TOKEN`) as a parameter to the `ApifyClient` constructor.
+
+
+
+
+ {AuthAsyncExample}
+
+
+
+
+ {AuthSyncExample}
+
+
+
+
+:::warning Secure access
+
+The API token is used to authorize your requests to the Apify API. You can be charged for the usage of the underlying services, so do not share your API token with untrusted parties or expose it on the client side of your applications.
+
+:::
+
+## Step 2: Run an Actor
+
+To start an Actor, call the `apify_client.actor()` method with the Actor's ID (e.g., `john-doe/my-cool-actor`). The Actor's ID is a combination of the Actor owner's username and the Actor name. You can run both your own Actors and Actors from [Apify Store](https://apify.com/store).
+
+To define the Actor's input, pass a dictionary to the `call()` method that matches the Actor's [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema). The input can include URLs to scrape, search terms, or other configuration data.
+
+
+
+
+ {InputAsyncExample}
+
+
+
+
+ {InputSyncExample}
+
+
+
+
+## Step 3: Get results from the dataset
+
+To get the results from the dataset, call the `apify_client.dataset()` method with the dataset ID, then call `list_items()` to retrieve the data. You can get the dataset ID from the Actor's run dictionary (represented by `defaultDatasetId`).
+
+
+
+
+ {DatasetAsyncExample}
+
+
+
+
+ {DatasetSyncExample}
+
+
+
+
+:::note Dataset access
+
+Running an Actor might take time, depending on the Actor's complexity and the amount of data it processes. If you want only to get data and have an immediate response, you should access the existing dataset of the finished [Actor run](https://docs.apify.com/platform/actors/running/runs-and-builds#runs).
+
+:::
+
+## Next steps
+
+### Concepts
+
+To learn more about how the client works, check out the Concepts section in the sidebar:
+
+- [Asyncio support](../02_concepts/01_async_support.mdx) - asynchronous programming with the client
+- [Single and collection clients](../02_concepts/02_single_collection_clients.mdx) - resource clients and collection clients
+- [Error handling](../02_concepts/04_error_handling.mdx) - automatic data extraction and error debugging
+- [Retries](../02_concepts/05_retries.mdx) - automatic retries with exponential backoff
+- [Pagination](../02_concepts/08_pagination.mdx) - iterating through large result sets
+
+### Guides
+
+For practical examples of common tasks, see the Guides section:
+
+- [Pass input to an Actor](../03_guides/01_passing_input_to_actor.mdx)
+- [Retrieve Actor data](../03_guides/03_retrieve_actor_data.mdx)
+- [Integrate with data libraries](../03_guides/04_integration_with_data_libraries.mdx)
diff --git a/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx b/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx
new file mode 100644
index 00000000..1d7efa13
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx
@@ -0,0 +1,22 @@
+---
+id: asyncio-support
+title: Asyncio support
+description: Use the async client for non-blocking API calls with Python asyncio.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ApiLink from '@theme/ApiLink';
+
+import AsyncSupportExample from '!!raw-loader!./code/01_async_support.py';
+
+The package provides an asynchronous version of the client, `ApifyClientAsync`, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. This is useful for applications that need to perform multiple API operations concurrently or integrate with other async frameworks.
+
+The following example shows how to run an Actor asynchronously and stream its logs while it is running:
+
+
+ {AsyncSupportExample}
+
+
+For the full async client API, see the `ApifyClientAsync` reference.
diff --git a/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx
new file mode 100644
index 00000000..1cdadc50
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx
@@ -0,0 +1,51 @@
+---
+id: single-and-collection-clients
+title: Single and collection clients
+description: Understand the two types of resource clients, single-resource and collection clients.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import CollectionAsyncExample from '!!raw-loader!./code/02_collection_async.py';
+import CollectionSyncExample from '!!raw-loader!./code/02_collection_sync.py';
+import SingleAsyncExample from '!!raw-loader!./code/02_single_async.py';
+import SingleSyncExample from '!!raw-loader!./code/02_single_sync.py';
+
+The Apify client provides two types of resource clients: single-resource clients for managing an individual resource, and collection clients for listing or creating resources.
+
+- `ActorClient` - Manages a single resource.
+- `ActorCollectionClient` - Manages a collection of resources.
+
+
+
+
+ {CollectionAsyncExample}
+
+
+
+
+ {CollectionSyncExample}
+
+
+
+
+The resource ID can be the resource's `id` or a combination of `username/resource-name`.
+
+
+
+
+ {SingleAsyncExample}
+
+
+
+
+ {SingleSyncExample}
+
+
+
+
+By utilizing the appropriate collection or resource client, you can simplify how you interact with the Apify API.
diff --git a/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx
new file mode 100644
index 00000000..95e512d1
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx
@@ -0,0 +1,31 @@
+---
+id: nested-clients
+title: Nested clients
+description: Access related resources directly through nested client methods.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import NestedAsyncExample from '!!raw-loader!./code/03_nested_async.py';
+import NestedSyncExample from '!!raw-loader!./code/03_nested_sync.py';
+
+Nested clients let you access related resources directly from a parent resource client, without manually constructing new client instances.
+
+
+
+
+ {NestedAsyncExample}
+
+
+
+
+ {NestedSyncExample}
+
+
+
+
+This direct access to [Dataset](https://docs.apify.com/platform/storage/dataset) (and other storage resources) from the `RunClient` is especially convenient when used alongside the `ActorClient.last_run` method.
diff --git a/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx b/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx
new file mode 100644
index 00000000..5eb1b4d0
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx
@@ -0,0 +1,46 @@
+---
+id: error-handling
+title: Error handling
+description: Handle API errors with the ApifyApiError exception and automatic data parsing.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ApiLink from '@theme/ApiLink';
+
+import ErrorAsyncExample from '!!raw-loader!./code/04_error_async.py';
+import ErrorSyncExample from '!!raw-loader!./code/04_error_sync.py';
+
+When you use the Apify client, it automatically extracts all relevant data from the endpoint and returns it in the expected format. Date strings, for instance, are seamlessly converted to Python `datetime.datetime` objects. If an error occurs, the client raises an `ApifyApiError`. This exception wraps the raw JSON errors returned by the API and provides additional context, making it easier to debug any issues that arise.
+
+## Error subclasses
+
+The Apify client provides dedicated error subclasses based on the HTTP status code of the failed response, so you can branch on error kind without inspecting `status_code` or `type`:
+
+| Status | Subclass |
+|---|---|
+| 400 | `InvalidRequestError` |
+| 401 | `UnauthorizedError` |
+| 403 | `ForbiddenError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 429 | `RateLimitError` |
+| 5xx | `ServerError` |
+
+All subclasses inherit from `ApifyApiError`, so an existing `except ApifyApiError` handler still catches every API error. Catch a specific subclass when you want to react differently to, for example, a missing resource or a rate-limit:
+
+
+
+
+ {ErrorAsyncExample}
+
+
+
+
+ {ErrorSyncExample}
+
+
+
+
+For a complete list of error classes, see the `ApifyApiError` reference.
diff --git a/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx b/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx
new file mode 100644
index 00000000..dfdf0917
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx
@@ -0,0 +1,45 @@
+---
+id: retries
+title: Retries
+description: Configure automatic retries with exponential backoff for failed requests.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import RetriesAsyncExample from '!!raw-loader!./code/05_retries_async.py';
+import RetriesSyncExample from '!!raw-loader!./code/05_retries_sync.py';
+
+The Apify client automatically retries requests that fail due to:
+
+- Network errors
+- Internal errors in the Apify API (HTTP status codes 500 and above)
+- Rate limit errors (HTTP status code 429)
+
+By default, the client retries a failed request up to 4 times. The retry intervals use an exponential backoff strategy:
+
+- The first retry occurs after approximately 500 milliseconds.
+- The second retry occurs after approximately 1,000 milliseconds, and so on.
+
+You can customize this behavior using the following options in the `ApifyClient` constructor:
+
+- `max_retries`: Defines the maximum number of retry attempts.
+- `min_delay_between_retries`: Sets the minimum delay between retries as a `timedelta`.
+
+Retries with exponential backoff help reduce the load on the server and increase the chances of a successful request.
+
+
+
+
+ {RetriesAsyncExample}
+
+
+
+
+ {RetriesSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx b/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx
new file mode 100644
index 00000000..4b4e8ed5
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx
@@ -0,0 +1,34 @@
+---
+id: logging
+title: Logging
+description: Configure debug logging to inspect API requests and responses.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import LoggingConfigExample from '!!raw-loader!./code/06_logging_config.py';
+import LoggingFormatterExample from '!!raw-loader!./code/06_logging_formatter.py';
+
+The library logs useful debug information to the `apify_client` logger whenever it sends requests to the Apify API. You can configure this logger to print debug information to the standard output by adding a handler:
+
+
+ {LoggingConfigExample}
+
+
+The log records include additional properties, provided via the extra argument, which can be helpful for debugging. Some of these properties are:
+
+- `attempt` - Number of retry attempts for the request.
+- `status_code` - HTTP status code of the response.
+- `url` - URL of the API endpoint being called.
+- `client_method` - Method name of the client that initiated the request.
+- `resource_id` - Identifier of the resource being accessed.
+
+To display these additional properties in the log output, you need to use a custom log formatter. Here's a basic example:
+
+
+ {LoggingFormatterExample}
+
+
+For more information on creating and using custom log formatters, refer to the official Python [logging documentation](https://docs.python.org/3/howto/logging.html#formatters).
diff --git a/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx b/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx
new file mode 100644
index 00000000..24a25593
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx
@@ -0,0 +1,42 @@
+---
+id: convenience-methods
+title: Convenience methods
+description: Use high-level methods for running Actors, waiting for results, and accessing data.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import CallAsyncExample from '!!raw-loader!./code/07_call_async.py';
+import CallSyncExample from '!!raw-loader!./code/07_call_sync.py';
+
+The Apify client provides several convenience methods to handle actions that the API alone cannot perform efficiently, such as waiting for an Actor run to finish without running into network timeouts. These methods simplify common tasks and enhance the usability of the client.
+
+- `ActorClient.call` - Starts an Actor and waits for it to finish, handling network timeouts internally. Waits indefinitely by default, or up to the specified `wait_duration`.
+- `ActorClient.start` - Starts an Actor and immediately returns the Run object without waiting for it to finish.
+- `RunClient.wait_for_finish` - Waits for an already-started run to reach a terminal status.
+
+Additionally, storage-related resources offer flexible options for data retrieval:
+
+- [Key-value store](https://docs.apify.com/platform/storage/key-value-store) records can be retrieved as objects, buffers, or streams.
+- [Dataset](https://docs.apify.com/platform/storage/dataset) items can be fetched as individual objects, serialized data, or iterated asynchronously.
+
+
+
+
+ {CallAsyncExample}
+
+
+
+
+ {CallSyncExample}
+
+
+
+
+:::tip
+The `call()` method polls internally and may take a long time for long-running Actors. Use `start()` and `wait_for_finish()` separately if you need more control over the waiting behavior.
+:::
diff --git a/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx b/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx
new file mode 100644
index 00000000..880f6c0c
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx
@@ -0,0 +1,83 @@
+---
+id: pagination
+title: Pagination
+description: Paginate through large result sets using page models or generator-based iteration.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import PaginationAsyncExample from '!!raw-loader!./code/08_pagination_async.py';
+import PaginationSyncExample from '!!raw-loader!./code/08_pagination_sync.py';
+import IterateItemsAsyncExample from '!!raw-loader!./code/08_iterate_items_async.py';
+import IterateItemsSyncExample from '!!raw-loader!./code/08_iterate_items_sync.py';
+import IterateCollectionAsyncExample from '!!raw-loader!./code/08_iterate_collection_async.py';
+import IterateCollectionSyncExample from '!!raw-loader!./code/08_iterate_collection_sync.py';
+
+Most methods named `list` or `list_something` in the Apify client return a page model — a [Pydantic](https://docs.pydantic.dev/latest/) model such as `ListOfActors`, `ListOfDatasets`, or `ListOfRequests`. Unstructured dataset items use the `DatasetItemsPage` dataclass instead. All page models share a consistent interface for working with paginated data and expose the following fields:
+
+- `items` - The main results you're looking for.
+- `total` - The total number of items available.
+- `offset` - The starting point of the current page.
+- `count` - The number of items in the current page.
+- `limit` - The maximum number of items per page.
+
+Some methods, such as `list_keys` or `list_head`, paginate differently. Regardless, the primary results are always stored under the `items` field, and the `limit` field can be used to control the number of results returned.
+
+The following example shows how to fetch all items from a dataset using pagination:
+
+
+
+
+ {PaginationAsyncExample}
+
+
+
+
+ {PaginationSyncExample}
+
+
+
+
+The page model interface offers several key benefits. Its consistent structure ensures predictable results for most `list` methods, providing a uniform way to work with paginated data. It also offers flexibility, allowing you to customize the `limit` and `offset` parameters to control data fetching according to your needs. Additionally, it provides scalability, enabling you to efficiently handle large datasets through pagination. This approach ensures efficient data retrieval while keeping memory usage under control, making it ideal for managing and processing large collections.
+
+## Generator-based iteration
+
+For collection clients, the `iterate` method returns an iterator that lazily fetches as many pages as needed
+to retrieve every item matching the filters. For dataset, key-value store and request queue clients, the
+matching helpers are `iterate_items`, `iterate_keys` and `iterate_requests`. They handle pagination
+automatically, so you don't need to manage offsets, limits or cursors yourself.
+
+The example below iterates over every Actor owned by the current user using a collection client's `iterate`
+method:
+
+
+
+
+ {IterateCollectionAsyncExample}
+
+
+
+
+ {IterateCollectionSyncExample}
+
+
+
+
+The next example uses `iterate_items` on a dataset client to stream items past a given offset:
+
+
+
+
+ {IterateItemsAsyncExample}
+
+
+
+
+ {IterateItemsSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx b/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx
new file mode 100644
index 00000000..53ea1fcf
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx
@@ -0,0 +1,41 @@
+---
+id: streaming-resources
+title: Streaming resources
+description: Stream large datasets, key-value store records, and logs without loading them into memory.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import ApiLink from '@theme/ApiLink';
+
+import StreamingAsyncExample from '!!raw-loader!./code/09_streaming_async.py';
+import StreamingSyncExample from '!!raw-loader!./code/09_streaming_sync.py';
+
+Certain resources, such as dataset items, key-value store records, and logs, support streaming directly from the Apify API. This allows you to process large resources incrementally without downloading them entirely into memory, making it ideal for handling large or continuously updated data.
+
+Supported streaming methods:
+
+- `DatasetClient.stream_items` - Stream dataset items incrementally.
+- `KeyValueStoreClient.stream_record` - Stream key-value store records as raw data.
+- `LogClient.stream` - Stream logs in real time.
+
+These methods return a raw, context-managed `impit.Response` object. The response must be consumed within a with block to ensure that the connection is closed automatically, preventing memory leaks or unclosed connections.
+
+The following example shows how to stream the logs of an Actor run incrementally:
+
+
+
+
+ {StreamingAsyncExample}
+
+
+
+
+ {StreamingSyncExample}
+
+
+
+
+Streaming is ideal for processing large logs, datasets, or files incrementally without downloading them entirely into memory.
diff --git a/website/versioned_docs/version-3.0/02_concepts/10_custom_http_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/10_custom_http_clients.mdx
new file mode 100644
index 00000000..d2d82a78
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/10_custom_http_clients.mdx
@@ -0,0 +1,132 @@
+---
+id: custom-http-clients
+title: Custom HTTP clients
+description: Replace the default HTTP client with a custom implementation.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ApiLink from '@theme/ApiLink';
+
+import DefaultHttpClientAsyncExample from '!!raw-loader!./code/10_default_http_client_async.py';
+import DefaultHttpClientSyncExample from '!!raw-loader!./code/10_default_http_client_sync.py';
+
+import ArchitectureImportsExample from '!!raw-loader!./code/10_architecture_imports.py';
+
+import PluggingInAsyncExample from '!!raw-loader!./code/10_plugging_in_async.py';
+import PluggingInSyncExample from '!!raw-loader!./code/10_plugging_in_sync.py';
+
+The Apify API client uses a pluggable HTTP client architecture. By default, it ships with an [Impit](https://github.com/apify/impit)-based HTTP client that handles retries, timeouts, passing headers, and more. You can replace it with your own implementation for use cases like custom logging, proxying, request modification, or integrating with a different HTTP library.
+
+## Default HTTP client
+
+When you create an `ApifyClient` or `ApifyClientAsync` instance, it automatically uses the built-in `ImpitHttpClient` (or `ImpitHttpClientAsync`). This default client provides:
+
+- Automatic retries with exponential backoff for network errors, HTTP 429, and HTTP 5xx responses.
+- Configurable timeouts.
+- Preparing request data and headers according to the API requirements, including authentication.
+- Collecting requests statistics for monitoring and debugging.
+
+You can configure the default client through the `ApifyClient` or `ApifyClientAsync` constructor:
+
+
+
+
+ {DefaultHttpClientAsyncExample}
+
+
+
+
+ {DefaultHttpClientSyncExample}
+
+
+
+
+## Architecture
+
+The HTTP client system is built on two key abstractions:
+
+- `HttpClient` / `HttpClientAsync` - Abstract base classes that define the interface. Extend one of these to create a custom HTTP client by implementing the `call` method.
+- `HttpResponse` - A [runtime-checkable protocol](https://docs.python.org/3/library/typing.html#typing.runtime_checkable) that defines the expected response shape. Any object with the required attributes and methods satisfies the protocol — no inheritance needed.
+
+To plug in your custom implementation, use the `ApifyClient.with_custom_http_client` class method.
+
+All of these are available as top-level imports from the `apify_client` package:
+
+
+ {ArchitectureImportsExample}
+
+
+### The call method
+
+The `call` method receives all the information needed to make an HTTP request:
+
+- `method` - HTTP method (`GET`, `POST`, `PUT`, `DELETE`, etc.).
+- `url` - Full URL to make the request to.
+- `headers` - Additional headers to include.
+- `params` - Query parameters to append to the URL.
+- `data` - Raw request body (mutually exclusive with `json`).
+- `json` - JSON-serializable request body (mutually exclusive with `data`).
+- `stream` - Whether to stream the response body.
+- `timeout` - Timeout for the request as a `timedelta`.
+
+It must return an object satisfying the `HttpResponse` protocol.
+
+### The HTTP response protocol
+
+`HttpResponse` is not a concrete class. Any object with the following attributes and methods will work:
+
+| Property / Method | Description |
+|---|---|
+| `status_code: int` | HTTP status code |
+| `text: str` | Response body as text |
+| `content: bytes` | Raw response body |
+| `headers: Mapping[str, str]` | Response headers |
+| `json() -> Any` | Parse body as JSON |
+| `read() -> bytes` | Read entire response body |
+| `aread() -> bytes` | Read entire response body (async) |
+| `close() -> None` | Close the response |
+| `aclose() -> None` | Close the response (async) |
+| `iter_bytes() -> Iterator[bytes]` | Iterate body in chunks |
+| `aiter_bytes() -> AsyncIterator[bytes]` | Iterate body in chunks (async) |
+
+:::note
+Many HTTP libraries, including our default [Impit](https://github.com/apify/impit) or for example [HTTPX](https://www.python-httpx.org/) already satisfy this protocol out of the box.
+:::
+
+### Plugging it in
+
+Use the `ApifyClient.with_custom_http_client` (or `ApifyClientAsync.with_custom_http_client`) class method to create a client with your custom implementation:
+
+
+
+
+ {PluggingInAsyncExample}
+
+
+
+
+ {PluggingInSyncExample}
+
+
+
+
+After that, all API calls made through the client will go through your custom HTTP client.
+
+:::warning
+When using a custom HTTP client, you are responsible for constructing the request, handling retries, timeouts, and errors yourself. The default retry logic is not applied.
+:::
+
+## Use cases
+
+Custom HTTP clients might be useful when you need to:
+
+- **Use a different HTTP library** - Swap Impit for [httpx](https://www.python-httpx.org/), [requests](https://requests.readthedocs.io/), or [aiohttp](https://docs.aiohttp.org/).
+- **Route through a proxy** - Add proxy support or request routing.
+- **Implement custom retry logic** - Use different backoff strategies or retry conditions.
+- **Log requests and responses** - Track API calls for debugging or auditing.
+- **Modify requests** - Add custom fields, modify the body, or change headers.
+- **Collect custom metrics** - Measure request latency, track error rates, or count API calls.
+
+For a step-by-step walkthrough of building a custom HTTP client, see the [Using HTTPX as the HTTP client](/api/client/python/docs/guides/custom-http-client-httpx) guide.
diff --git a/website/versioned_docs/version-3.0/02_concepts/11_timeouts.mdx b/website/versioned_docs/version-3.0/02_concepts/11_timeouts.mdx
new file mode 100644
index 00000000..54e56ea7
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/11_timeouts.mdx
@@ -0,0 +1,62 @@
+---
+id: timeouts
+title: Timeouts
+description: Configure the tiered timeout system for controlling how long API requests can take.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ApiLink from '@theme/ApiLink';
+
+import TimeoutsAsyncExample from '!!raw-loader!./code/11_timeouts_async.py';
+import TimeoutsSyncExample from '!!raw-loader!./code/11_timeouts_sync.py';
+
+The Apify client uses a tiered timeout system to set appropriate time limits for different types of API requests. Each tier has a default value suited to its use case:
+
+| Tier | Default | Purpose |
+|---|---|---|
+| `short` | 5 seconds | Fast CRUD operations (get, update, delete) |
+| `medium` | 30 seconds | Batch, list, and data transfer operations |
+| `long` | 360 seconds | Long-polling, streaming, and heavy operations |
+| `no_timeout` | — | Disables the timeout entirely |
+
+Every client method has a pre-assigned tier that matches the expected duration of the underlying API call. You generally don't need to change these unless you're working with unusually large payloads or slow network conditions.
+
+## Configuring default timeouts
+
+You can override the default values for each tier in the `ApifyClient` or `ApifyClientAsync` constructor. The `timeout_max` parameter sets an upper cap on the timeout for any individual API request, limiting exponential growth during retries.
+
+
+
+
+ {TimeoutsAsyncExample}
+
+
+
+
+ {TimeoutsSyncExample}
+
+
+
+
+## Per-call overrides
+
+Most client methods accept a `timeout` parameter that overrides the default tier for that specific call. You can pass either a `timedelta` for an exact duration or a tier literal (`'short'`, `'medium'`, `'long'`, `'no_timeout'`) to switch tiers.
+
+```python
+from datetime import timedelta
+
+# Use an exact timeout for this call.
+client.dataset('id').list_items(timeout=timedelta(seconds=120))
+
+# Switch to a different tier.
+client.dataset('id').list_items(timeout='long')
+
+# Disable the timeout entirely.
+client.dataset('id').list_items(timeout='no_timeout')
+```
+
+## Interaction with retries
+
+Timeouts work together with the [retry system](/api/client/python/docs/concepts/retries). When a request times out, it counts as a failed attempt and triggers a retry (up to `max_retries`). The timeout applies to each individual attempt, not the total time across all retries.
diff --git a/website/versioned_docs/version-3.0/02_concepts/12_typed_models.mdx b/website/versioned_docs/version-3.0/02_concepts/12_typed_models.mdx
new file mode 100644
index 00000000..58df78ec
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/12_typed_models.mdx
@@ -0,0 +1,73 @@
+---
+id: typed-models
+title: Typed models
+description: Resource client methods return Pydantic models generated from the Apify OpenAPI spec, with IDE autocomplete, runtime validation, and forward-compatible field access.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ApiLink from '@theme/ApiLink';
+
+import AccessAsyncExample from '!!raw-loader!./code/12_typed_models_access_async.py';
+import AccessSyncExample from '!!raw-loader!./code/12_typed_models_access_sync.py';
+
+import InputAsyncExample from '!!raw-loader!./code/12_typed_models_input_async.py';
+import InputSyncExample from '!!raw-loader!./code/12_typed_models_input_sync.py';
+
+Resource client methods return [Pydantic](https://docs.pydantic.dev/) models generated directly from the [Apify OpenAPI specification](https://docs.apify.com/api/openapi.json). You get IDE autocompletion, runtime validation of API responses, and a Python-idiomatic snake_case interface on top of the underlying camelCase API.
+
+## Accessing response fields
+
+Every method that returns a structured payload returns a Pydantic model. Fields are accessed using their Python snake_case names regardless of the camelCase used by the API, and the static type of each field comes through to your editor.
+
+
+
+
+ {AccessAsyncExample}
+
+
+
+
+ {AccessSyncExample}
+
+
+
+
+Date strings are automatically parsed into timezone-aware `datetime.datetime` objects, enums into `Literal` aliases, and nested objects into their own typed models, so you can compose attribute access without manual conversion.
+
+## Providing structured input
+
+A Pydantic model returned from one client call can be passed directly into any other method that accepts the same shape — useful for round-trip flows where you read a resource, tweak it, and write it back.
+
+For input you construct yourself, plain dictionaries work on every input method. Each input shape has a matching [`TypedDict`](https://docs.python.org/3/library/typing.html#typing.TypedDict) that documents the expected keys.
+
+
+
+
+ {InputAsyncExample}
+
+
+
+
+ {InputSyncExample}
+
+
+
+
+## Forward compatibility
+
+Generated models are configured with `extra='allow'`. Any new fields the API starts returning in the future are preserved on the model instance — they simply do not yet have a typed attribute. Upgrading the client to pick up a newer OpenAPI spec is a non-breaking change for code that reads existing fields.
+
+## Browsing all models
+
+The full list of generated models and TypedDicts is available in the [API reference](/api/client/python/reference) under the **Models** and **Typed dicts** groups.
+
+## Methods that return plain types
+
+A few endpoints intentionally return plain Python types instead of Pydantic models because their payloads are user-defined or inherently unstructured:
+
+- `DatasetClient.list_items()` returns a `DatasetItemsPage` whose `items` field is `list[dict[str, Any]]`. Dataset items follow the [Actor output schema](https://docs.apify.com/platform/actors/development/actor-definition/output-schema), which the client cannot know in advance.
+- `KeyValueStoreClient.get_record()` returns a `dict` with `key`, `value`, and `content_type` keys. The shape of `value` is determined by the record's content type.
+
+For background on the migration from plain dicts to typed models, see [Upgrading to v3](../04_upgrading/upgrading_to_v3.mdx).
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py b/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py
new file mode 100644
index 00000000..e8fe81b0
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py
@@ -0,0 +1,25 @@
+import asyncio
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ actor_client = apify_client.actor('my-actor-id')
+
+ # Start the Actor and get the run ID
+ run_result = await actor_client.start()
+ run_client = apify_client.run(run_result.id)
+ log_client = run_client.log()
+
+ # Stream the logs
+ async with log_client.stream() as async_log_stream:
+ if async_log_stream:
+ async for bytes_chunk in async_log_stream.aiter_bytes():
+ print(bytes_chunk)
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py
new file mode 100644
index 00000000..85ed3290
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # Collection clients do not require a parameter
+ actor_collection_client = apify_client.actors()
+
+ # Create an Actor with the name: my-actor
+ my_actor = await actor_collection_client.create(name='my-actor')
+
+ # List all of your Actors
+ actor_list = (await actor_collection_client.list()).items
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py
new file mode 100644
index 00000000..988e41e7
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # Collection clients do not require a parameter
+ actor_collection_client = apify_client.actors()
+
+ # Create an Actor with the name: my-actor
+ my_actor = actor_collection_client.create(name='my-actor')
+
+ # List all of your Actors
+ actor_list = actor_collection_client.list().items
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py b/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py
new file mode 100644
index 00000000..c6b1a0ac
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # Resource clients accept an ID of the resource
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Fetch the 'username/actor-name' object from the API
+ my_actor = await actor_client.get()
+
+ # Start the run of 'username/actor-name' and return the Run object
+ my_actor_run = await actor_client.start()
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py
new file mode 100644
index 00000000..033e54de
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # Resource clients accept an ID of the resource
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Fetch the 'username/actor-name' object from the API
+ my_actor = actor_client.get()
+
+ # Start the run of 'username/actor-name' and return the Run object
+ my_actor_run = actor_client.start()
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py
new file mode 100644
index 00000000..f1d4c27f
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py
@@ -0,0 +1,22 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ actor_client = apify_client.actor('username/actor-name')
+ runs_client = actor_client.runs()
+
+ # List the last 10 runs of the Actor.
+ actor_runs = (await runs_client.list(limit=10, desc=True)).items
+
+ # Select the last run of the Actor that finished with a SUCCEEDED status.
+ last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED')
+
+ # Get dataset
+ actor_run_dataset_client = last_succeeded_run_client.dataset()
+
+ # Fetch items from the run's dataset
+ dataset_items = (await actor_run_dataset_client.list_items()).items
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py
new file mode 100644
index 00000000..65ae8dd2
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py
@@ -0,0 +1,22 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ actor_client = apify_client.actor('username/actor-name')
+ runs_client = actor_client.runs()
+
+ # List the last 10 runs of the Actor.
+ actor_runs = runs_client.list(limit=10, desc=True).items
+
+ # Select the last run of the Actor that finished with a SUCCEEDED status.
+ last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED')
+
+ # Get dataset
+ actor_run_dataset_client = last_succeeded_run_client.dataset()
+
+ # Fetch items from the run's dataset
+ dataset_items = actor_run_dataset_client.list_items().items
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py b/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py
new file mode 100644
index 00000000..967ed2eb
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py
@@ -0,0 +1,28 @@
+import asyncio
+
+from apify_client import ApifyClientAsync
+from apify_client.errors import ApifyApiError, NotFoundError
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ try:
+ # Try to list items from a non-existing dataset.
+ dataset_client = apify_client.dataset('non-existing-dataset-id')
+ dataset_items = (await dataset_client.list_items()).items
+ except NotFoundError:
+ # 404 — branch on a specific subclass when you want to react to it.
+ dataset_items = []
+ except ApifyApiError as err:
+ # Catch-all for every other API error.
+ print(f'API error: {err}')
+ dataset_items = []
+
+ print(f'Fetched {len(dataset_items)} items.')
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py
new file mode 100644
index 00000000..7d100ba9
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py
@@ -0,0 +1,26 @@
+from apify_client import ApifyClient
+from apify_client.errors import ApifyApiError, NotFoundError
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ try:
+ # Try to list items from a non-existing dataset.
+ dataset_client = apify_client.dataset('non-existing-dataset-id')
+ dataset_items = dataset_client.list_items().items
+ except NotFoundError:
+ # 404 — branch on a specific subclass when you want to react to it.
+ dataset_items = []
+ except ApifyApiError as err:
+ # Catch-all for every other API error.
+ print(f'API error: {err}')
+ dataset_items = []
+
+ print(f'Fetched {len(dataset_items)} items.')
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py
new file mode 100644
index 00000000..5a349685
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py
@@ -0,0 +1,17 @@
+from datetime import timedelta
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(
+ token=TOKEN,
+ max_retries=4,
+ min_delay_between_retries=timedelta(milliseconds=500),
+ timeout_short=timedelta(seconds=5),
+ timeout_medium=timedelta(seconds=30),
+ timeout_long=timedelta(seconds=360),
+ timeout_max=timedelta(seconds=360),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py
new file mode 100644
index 00000000..b714b536
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py
@@ -0,0 +1,17 @@
+from datetime import timedelta
+
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(
+ token=TOKEN,
+ max_retries=4,
+ min_delay_between_retries=timedelta(milliseconds=500),
+ timeout_short=timedelta(seconds=5),
+ timeout_medium=timedelta(seconds=30),
+ timeout_long=timedelta(seconds=360),
+ timeout_max=timedelta(seconds=360),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py
new file mode 100644
index 00000000..e31a7fda
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py
@@ -0,0 +1,6 @@
+import logging
+
+# Configure the Apify client logger
+apify_client_logger = logging.getLogger('apify_client')
+apify_client_logger.setLevel(logging.DEBUG)
+apify_client_logger.addHandler(logging.StreamHandler())
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py
new file mode 100644
index 00000000..efeeb695
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py
@@ -0,0 +1,15 @@
+import logging
+
+# Configure the Apify client logger
+apify_client_logger = logging.getLogger('apify_client')
+apify_client_logger.setLevel(logging.DEBUG)
+apify_client_logger.addHandler(logging.StreamHandler())
+
+# Create a custom logging formatter
+formatter = logging.Formatter(
+ '%(asctime)s - %(name)s - %(levelname)s - %(message)s - '
+ '%(attempt)s - %(status_code)s - %(url)s'
+)
+handler = logging.StreamHandler()
+handler.setFormatter(formatter)
+apify_client_logger.addHandler(handler)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py b/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py
new file mode 100644
index 00000000..3fe5a56f
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py
@@ -0,0 +1,14 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Start an Actor and wait for it to finish.
+ finished_actor_run = await actor_client.call()
+
+ # Start an Actor and wait up to 60 seconds for it to finish.
+ actor_run = await actor_client.start(wait_for_finish=60)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py
new file mode 100644
index 00000000..366f32ef
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py
@@ -0,0 +1,14 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ actor_client = apify_client.actor('username/actor-name')
+
+ # Start an Actor and wait for it to finish.
+ finished_actor_run = actor_client.call()
+
+ # Start an Actor and wait up to 60 seconds for it to finish.
+ actor_run = actor_client.start(wait_for_finish=60)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_async.py
new file mode 100644
index 00000000..42627b0a
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_async.py
@@ -0,0 +1,12 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # Iterate over all Actors owned by the current user, lazily fetching
+ # as many pages as needed under the hood.
+ async for actor in apify_client.actors().iterate(my=True):
+ print(actor.id)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_sync.py
new file mode 100644
index 00000000..556f2996
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_sync.py
@@ -0,0 +1,16 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # Iterate over all Actors owned by the current user, lazily fetching
+ # as many pages as needed under the hood.
+ for actor in apify_client.actors().iterate(my=True):
+ print(actor.id)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_async.py
new file mode 100644
index 00000000..e727680e
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_async.py
@@ -0,0 +1,17 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Define the pagination parameters
+ limit = 1500 # Number of items in total
+ offset = 100 # Starting offset
+
+ # Iterate through items automatically, lazily sending as many API calls
+ # as needed and receiving items in chunks.
+ async for item in dataset_client.iterate_items(limit=limit, offset=offset):
+ print(item) # Process the item as needed
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_sync.py
new file mode 100644
index 00000000..2b6ed487
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_sync.py
@@ -0,0 +1,21 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Define the pagination parameters
+ limit = 1500 # Number of items in total
+ offset = 100 # Starting offset
+
+ # Iterate through items automatically, lazily sending as many API calls
+ # as needed and receiving items in chunks.
+ for item in dataset_client.iterate_items(limit=limit, offset=offset):
+ print(item) # Process the item as needed
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py
new file mode 100644
index 00000000..23ac5fde
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py
@@ -0,0 +1,24 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # Initialize the dataset client
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Define the pagination parameters
+ limit = 1000 # Number items to request from API
+ offset = 0 # Starting offset
+
+ # Send single API call to fetch paginated items.
+ # (number of items per single call can be limited by API)
+ paginated_items = await dataset_client.list_items(limit=limit, offset=offset)
+
+ # Inspect pagination metadata returned by API
+ print(paginated_items.total)
+
+ for item in paginated_items.items:
+ print(item) # Process the item as needed
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py
new file mode 100644
index 00000000..f144339e
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py
@@ -0,0 +1,24 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # Initialize the dataset client
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Define the pagination parameters
+ limit = 1000 # Number items to request from API
+ offset = 0 # Starting offset
+
+ # Send single API call to fetch paginated items.
+ # (number of items per single call can be limited by API)
+ paginated_items = dataset_client.list_items(limit=limit, offset=offset)
+
+ # Inspect pagination metadata returned by API
+ print(paginated_items.total)
+
+ for item in paginated_items.items:
+ print(item) # Process the item as needed
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py
new file mode 100644
index 00000000..5459784e
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py
@@ -0,0 +1,14 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ run_client = apify_client.run('MY-RUN-ID')
+ log_client = run_client.log()
+
+ async with log_client.stream() as log_stream:
+ if log_stream:
+ async for bytes_chunk in log_stream.aiter_bytes():
+ print(bytes_chunk)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py
new file mode 100644
index 00000000..e7617ab3
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py
@@ -0,0 +1,14 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ run_client = apify_client.run('MY-RUN-ID')
+ log_client = run_client.log()
+
+ with log_client.stream() as log_stream:
+ if log_stream:
+ for bytes_chunk in log_stream.iter_bytes():
+ print(bytes_chunk)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/10_architecture_imports.py b/website/versioned_docs/version-3.0/02_concepts/code/10_architecture_imports.py
new file mode 100644
index 00000000..c462b2f9
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/10_architecture_imports.py
@@ -0,0 +1,5 @@
+from apify_client.http_clients import (
+ HttpClient,
+ HttpClientAsync,
+ HttpResponse,
+)
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_async.py b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_async.py
new file mode 100644
index 00000000..046a669f
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_async.py
@@ -0,0 +1,14 @@
+from datetime import timedelta
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ client = ApifyClientAsync(
+ token=TOKEN,
+ max_retries=4,
+ min_delay_between_retries=timedelta(milliseconds=500),
+ timeout_medium=timedelta(seconds=360),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_sync.py
new file mode 100644
index 00000000..1f12e06a
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_sync.py
@@ -0,0 +1,14 @@
+from datetime import timedelta
+
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ client = ApifyClient(
+ token=TOKEN,
+ max_retries=4,
+ min_delay_between_retries=timedelta(milliseconds=500),
+ timeout_medium=timedelta(seconds=360),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_async.py b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_async.py
new file mode 100644
index 00000000..331f0b62
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_async.py
@@ -0,0 +1,31 @@
+from typing import Any
+
+from apify_client import ApifyClientAsync
+from apify_client.http_clients import HttpClientAsync, HttpResponse
+from apify_client.types import Timeout
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+class MyHttpClientAsync(HttpClientAsync):
+ """Custom async HTTP client."""
+
+ async def call(
+ self,
+ *,
+ method: str,
+ url: str,
+ headers: dict[str, str] | None = None,
+ params: dict[str, Any] | None = None,
+ data: str | bytes | bytearray | None = None,
+ json: Any = None,
+ stream: bool | None = None,
+ timeout: Timeout = 'medium',
+ ) -> HttpResponse: ...
+
+
+async def main() -> None:
+ client = ApifyClientAsync.with_custom_http_client(
+ token=TOKEN,
+ http_client=MyHttpClientAsync(),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_sync.py
new file mode 100644
index 00000000..386281ae
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_sync.py
@@ -0,0 +1,31 @@
+from typing import Any
+
+from apify_client import ApifyClient
+from apify_client.http_clients import HttpClient, HttpResponse
+from apify_client.types import Timeout
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+class MyHttpClient(HttpClient):
+ """Custom sync HTTP client."""
+
+ def call(
+ self,
+ *,
+ method: str,
+ url: str,
+ headers: dict[str, str] | None = None,
+ params: dict[str, Any] | None = None,
+ data: str | bytes | bytearray | None = None,
+ json: Any = None,
+ stream: bool | None = None,
+ timeout: Timeout = 'medium',
+ ) -> HttpResponse: ...
+
+
+def main() -> None:
+ client = ApifyClient.with_custom_http_client(
+ token=TOKEN,
+ http_client=MyHttpClient(),
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_async.py b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_async.py
new file mode 100644
index 00000000..c402a44b
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_async.py
@@ -0,0 +1,24 @@
+from datetime import timedelta
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ # Configure default timeout tiers globally.
+ apify_client = ApifyClientAsync(
+ token=TOKEN,
+ timeout_short=timedelta(seconds=10),
+ timeout_medium=timedelta(seconds=60),
+ timeout_long=timedelta(seconds=600),
+ timeout_max=timedelta(seconds=600),
+ )
+
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Override the timeout for a single call using a timedelta.
+ items = await dataset_client.list_items(timeout=timedelta(seconds=120))
+
+ # Or use a tier literal to select a predefined timeout.
+ items = await dataset_client.list_items(timeout='long')
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_sync.py
new file mode 100644
index 00000000..fc027706
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_sync.py
@@ -0,0 +1,24 @@
+from datetime import timedelta
+
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ # Configure default timeout tiers globally.
+ apify_client = ApifyClient(
+ token=TOKEN,
+ timeout_short=timedelta(seconds=10),
+ timeout_medium=timedelta(seconds=60),
+ timeout_long=timedelta(seconds=600),
+ timeout_max=timedelta(seconds=600),
+ )
+
+ dataset_client = apify_client.dataset('dataset-id')
+
+ # Override the timeout for a single call using a timedelta.
+ items = dataset_client.list_items(timeout=timedelta(seconds=120))
+
+ # Or use a tier literal to select a predefined timeout.
+ items = dataset_client.list_items(timeout='long')
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_async.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_async.py
new file mode 100644
index 00000000..6d0caeb1
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_async.py
@@ -0,0 +1,18 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+
+ # `get` returns an `Actor` Pydantic model — fields are typed and IDE-completable.
+ actor = await apify_client.actor('apify/hello-world').get()
+ if actor is None:
+ return
+
+ print(actor.id) # str
+ print(actor.username) # str
+ print(actor.is_public) # bool
+ print(actor.created_at) # datetime.datetime (timezone-aware)
+ print(actor.stats.total_runs) # int — nested model, attribute access all the way down
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_sync.py
new file mode 100644
index 00000000..e616d1ec
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_sync.py
@@ -0,0 +1,18 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+
+ # `get` returns an `Actor` Pydantic model — fields are typed and IDE-completable.
+ actor = apify_client.actor('apify/hello-world').get()
+ if actor is None:
+ return
+
+ print(actor.id) # str
+ print(actor.username) # str
+ print(actor.is_public) # bool
+ print(actor.created_at) # datetime.datetime (timezone-aware)
+ print(actor.stats.total_runs) # int — nested model, attribute access all the way down
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_async.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_async.py
new file mode 100644
index 00000000..91568a71
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_async.py
@@ -0,0 +1,17 @@
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(TOKEN)
+ rq_client = apify_client.request_queue('REQUEST-QUEUE-ID')
+
+ # Plain dict — keys may be snake_case or camelCase.
+ await rq_client.add_request(
+ {
+ 'url': 'https://example.com',
+ 'unique_key': 'https://example.com',
+ 'method': 'GET',
+ }
+ )
diff --git a/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_sync.py
new file mode 100644
index 00000000..71c08022
--- /dev/null
+++ b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_sync.py
@@ -0,0 +1,17 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ apify_client = ApifyClient(TOKEN)
+ rq_client = apify_client.request_queue('REQUEST-QUEUE-ID')
+
+ # Plain dict — keys may be snake_case or camelCase.
+ rq_client.add_request(
+ {
+ 'url': 'https://example.com',
+ 'unique_key': 'https://example.com',
+ 'method': 'GET',
+ }
+ )
diff --git a/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx b/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx
new file mode 100644
index 00000000..5ac6b91c
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx
@@ -0,0 +1,29 @@
+---
+id: passing-input-to-actor
+title: Pass input to an Actor
+description: Run an Actor with custom input data and retrieve results.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import StreamingAsyncExample from '!!raw-loader!./code/01_input_async.py';
+import StreamingSyncExample from '!!raw-loader!./code/01_input_sync.py';
+
+You can pass input data directly to the `call` method to configure and run an Actor in a single step.
+
+The following example shows how to pass input to the `apify/instagram-hashtag-scraper` Actor and wait for it to finish.
+
+
+
+
+ {StreamingAsyncExample}
+
+
+
+
+ {StreamingSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx b/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx
new file mode 100644
index 00000000..205c77c5
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx
@@ -0,0 +1,29 @@
+---
+id: manage-tasks-for-reusable-input
+title: Manage tasks for reusable input
+description: Create and manage tasks with reusable input configurations.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import TasksAsyncExample from '!!raw-loader!./code/02_tasks_async.py';
+import TasksSyncExample from '!!raw-loader!./code/02_tasks_sync.py';
+
+When you need to run multiple inputs with the same Actor, the most convenient approach is to create multiple [tasks](https://docs.apify.com/platform/actors/running/tasks), each with different input configurations. Task inputs are stored on the Apify platform when the task is created, allowing you to reuse them easily.
+
+The following example shows how to create tasks for the `apify/instagram-hashtag-scraper` Actor with different inputs, manage task clients, and execute them asynchronously:
+
+
+
+
+ {TasksAsyncExample}
+
+
+
+
+ {TasksSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx b/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx
new file mode 100644
index 00000000..7490f114
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx
@@ -0,0 +1,29 @@
+---
+id: retrieve-actor-data
+title: Retrieve Actor data
+description: Fetch, paginate, and merge datasets from Actor runs.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import RetrieveAsyncExample from '!!raw-loader!./code/03_retrieve_async.py';
+import RetrieveSyncExample from '!!raw-loader!./code/03_retrieve_sync.py';
+
+Actor output data is stored in [datasets](https://docs.apify.com/platform/storage/dataset), which can be retrieved from individual Actor runs. Dataset items support pagination for efficient retrieval, and multiple datasets can be merged into a single dataset for further analysis. This merged dataset can then be exported into various formats such as CSV, JSON, XLSX, or XML. Additionally, [integrations](https://docs.apify.com/platform/integrations) provide powerful tools to automate data workflows.
+
+The following example shows how to fetch datasets from an Actor's runs, paginate through their items, and merge them into a single dataset for unified analysis:
+
+
+
+
+ {RetrieveAsyncExample}
+
+
+
+
+ {RetrieveSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx b/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx
new file mode 100644
index 00000000..ab5dc4f7
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx
@@ -0,0 +1,29 @@
+---
+id: integration-with-data-libraries
+title: Integrate with data libraries
+description: Load Apify dataset items into Pandas DataFrames for analysis.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import PandasAsyncExample from '!!raw-loader!./code/04_pandas_async.py';
+import PandasSyncExample from '!!raw-loader!./code/04_pandas_sync.py';
+
+The Apify client for Python seamlessly integrates with data analysis libraries like [Pandas](https://pandas.pydata.org/). This allows you to load dataset items directly into a Pandas [DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) for efficient manipulation and analysis. Pandas provides robust data structures and tools for handling large datasets, making it a powerful addition to your Apify workflows.
+
+The following example shows how to retrieve items from the most recent dataset of an Actor run and load them into a Pandas DataFrame for further analysis:
+
+
+
+
+ {PandasAsyncExample}
+
+
+
+
+ {PandasSyncExample}
+
+
+
diff --git a/website/versioned_docs/version-3.0/03_guides/05_custom_http_client.mdx b/website/versioned_docs/version-3.0/03_guides/05_custom_http_client.mdx
new file mode 100644
index 00000000..9b34fec1
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/05_custom_http_client.mdx
@@ -0,0 +1,62 @@
+---
+id: custom-http-client-httpx
+title: Use HTTPX as the HTTP client
+description: Replace the default Impit HTTP client with one based on HTTPX.
+---
+
+import ApiLink from '@theme/ApiLink';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+
+import CustomHttpClientAsyncExample from '!!raw-loader!./code/05_custom_http_client_async.py';
+import CustomHttpClientSyncExample from '!!raw-loader!./code/05_custom_http_client_sync.py';
+
+This guide shows how to replace the default `ImpitHttpClient` and `ImpitHttpClientAsync` with one based on [HTTPX](https://www.python-httpx.org/). The same approach works for any HTTP library — see [Custom HTTP clients](/api/client/python/docs/concepts/custom-http-clients) for the underlying architecture.
+
+## Why HTTPX?
+
+You might want to use [HTTPX](https://www.python-httpx.org/) instead of the default [Impit](https://github.com/apify/impit)-based client for reasons like:
+
+- You already use HTTPX in your project and want a single HTTP stack.
+- You need HTTPX-specific features.
+- You want fine-grained control over connection pooling or proxy routing.
+
+## Implementation
+
+The implementation involves two steps:
+
+1. **Extend `HttpClient` (sync) or `HttpClientAsync` (async)** and implement the `call` method that delegates to HTTPX.
+2. **Pass it to `ApifyClient.with_custom_http_client`** to create a client that uses your implementation.
+
+The `call` method receives parameters like `method`, `url`, `headers`, `params`, `data`, `json`, `stream`, and `timeout`. Map them to the corresponding HTTPX arguments — most map directly, except `data` which becomes HTTPX's `content` parameter and `timeout` which needs conversion from `timedelta` to seconds.
+
+A convenient property of HTTPX is that its `httpx.Response` object already satisfies the `HttpResponse` protocol, so you can return it directly without wrapping.
+
+
+
+
+ {CustomHttpClientAsyncExample}
+
+
+
+
+ {CustomHttpClientSyncExample}
+
+
+
+
+:::warning
+When using a custom HTTP client, you are responsible for handling retries, timeouts, and error handling yourself. The built-in retry logic with exponential backoff is part of the default `ImpitHttpClient` and is not applied to custom implementations.
+:::
+
+## Going further
+
+The example above is minimal on purpose. In a production setup, you might want to extend it with:
+
+- **Retry logic** - Use [HTTPX's event hooks](https://www.python-httpx.org/advanced/event-hooks/) or utilize library like [tenacity](https://tenacity.readthedocs.io/) to retry failed requests.
+- **Custom headers** - You can add headers in the `call` method before delegating to HTTPX.
+- **Connection lifecycle** - Close the underlying `httpx.Client` when done by adding a `close()` method to your custom client.
+- **Proxy support** - You can pass `proxy=...` when creating the `httpx.Client`.
+- **Metrics collection** - Track request latency, error rates, or other metrics by adding instrumentation in the `call` method.
+- **Logging** - Log requests and responses for debugging or auditing purposes.
diff --git a/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py b/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py
new file mode 100644
index 00000000..c225a0a2
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py
@@ -0,0 +1,26 @@
+import asyncio
+from datetime import timedelta
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ # Client initialization with the API token
+ apify_client = ApifyClientAsync(token=TOKEN)
+
+ # Get the Actor client
+ actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+
+ input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20}
+
+ # Run the Actor and wait for it to finish up to 60 seconds.
+ # Input is not persisted for next runs.
+ run_result = await actor_client.call(
+ run_input=input_data, timeout=timedelta(seconds=60)
+ )
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py b/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py
new file mode 100644
index 00000000..ea99665c
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py
@@ -0,0 +1,23 @@
+from datetime import timedelta
+
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ # Client initialization with the API token
+ apify_client = ApifyClient(token=TOKEN)
+
+ # Get the Actor client
+ actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+
+ input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20}
+
+ # Run the Actor and wait for it to finish up to 60 seconds.
+ # Input is not persisted for next runs.
+ run_result = actor_client.call(run_input=input_data, timeout=timedelta(seconds=60))
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py
new file mode 100644
index 00000000..19e38304
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py
@@ -0,0 +1,45 @@
+import asyncio
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+HASHTAGS = ['zebra', 'lion', 'hippo']
+
+
+async def main() -> None:
+ apify_client = ApifyClientAsync(token=TOKEN)
+
+ # Create Apify tasks
+ apify_tasks = []
+ apify_tasks_client = apify_client.tasks()
+
+ for hashtag in HASHTAGS:
+ apify_task = await apify_tasks_client.create(
+ name=f'hashtags-{hashtag}',
+ actor_id='apify/instagram-hashtag-scraper',
+ task_input={'hashtags': [hashtag], 'resultsLimit': 20},
+ memory_mbytes=1024,
+ )
+ apify_tasks.append(apify_task)
+
+ print('Tasks created:', apify_tasks)
+
+ # Create Apify task clients
+ apify_task_clients = [apify_client.task(task.id) for task in apify_tasks]
+
+ print('Task clients created:', apify_task_clients)
+
+ # Execute Apify tasks
+ async with asyncio.TaskGroup() as tg:
+ tasks = [tg.create_task(client.call()) for client in apify_task_clients]
+
+ task_run_results = [task.result() for task in tasks]
+
+ # Filter out None results (tasks that failed to return a run)
+ successful_runs = [run for run in task_run_results if run is not None]
+
+ print('Task results:', successful_runs)
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py
new file mode 100644
index 00000000..e869727b
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py
@@ -0,0 +1,40 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+HASHTAGS = ['zebra', 'lion', 'hippo']
+
+
+def main() -> None:
+ apify_client = ApifyClient(token=TOKEN)
+
+ # Create Apify tasks
+ apify_tasks = []
+ apify_tasks_client = apify_client.tasks()
+
+ for hashtag in HASHTAGS:
+ apify_task = apify_tasks_client.create(
+ name=f'hashtags-{hashtag}',
+ actor_id='apify/instagram-hashtag-scraper',
+ task_input={'hashtags': [hashtag], 'resultsLimit': 20},
+ memory_mbytes=1024,
+ )
+ apify_tasks.append(apify_task)
+
+ print('Tasks created:', apify_tasks)
+
+ # Create Apify task clients
+ apify_task_clients = [apify_client.task(task.id) for task in apify_tasks]
+
+ print('Task clients created:', apify_task_clients)
+
+ # Execute Apify tasks
+ task_run_results = [client.call() for client in apify_task_clients]
+
+ # Filter out None results (tasks that failed to return a run)
+ successful_runs = [run for run in task_run_results if run is not None]
+
+ print('Task results:', successful_runs)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py
new file mode 100644
index 00000000..fc60d068
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py
@@ -0,0 +1,33 @@
+import asyncio
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ # Client initialization with the API token
+ apify_client = ApifyClientAsync(token=TOKEN)
+ actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+ runs_client = actor_client.runs()
+
+ # See pagination to understand how to get more datasets
+ actor_datasets = await runs_client.list(limit=20)
+
+ datasets_client = apify_client.datasets()
+ merging_dataset = await datasets_client.get_or_create(name='merge-dataset')
+
+ for dataset_item in actor_datasets.items:
+ # Dataset items can be handled here. Dataset items can be paginated
+ dataset_client = apify_client.dataset(dataset_item.id)
+ dataset_items = await dataset_client.list_items(limit=1000)
+
+ # Items can be pushed to single dataset
+ merging_dataset_client = apify_client.dataset(merging_dataset.id)
+ await merging_dataset_client.push_items(dataset_items.items)
+
+ # ...
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py
new file mode 100644
index 00000000..24e05e2f
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py
@@ -0,0 +1,31 @@
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ # Client initialization with the API token
+ apify_client = ApifyClient(token=TOKEN)
+ actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+ runs_client = actor_client.runs()
+
+ # See pagination to understand how to get more datasets
+ actor_datasets = runs_client.list(limit=20)
+
+ datasets_client = apify_client.datasets()
+ merging_dataset = datasets_client.get_or_create(name='merge-dataset')
+
+ for dataset_item in actor_datasets.items:
+ # Dataset items can be handled here. Dataset items can be paginated
+ dataset_client = apify_client.dataset(dataset_item.id)
+ dataset_items = dataset_client.list_items(limit=1000)
+
+ # Items can be pushed to single dataset
+ merging_dataset_client = apify_client.dataset(merging_dataset.id)
+ merging_dataset_client.push_items(dataset_items.items)
+
+ # ...
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py
new file mode 100644
index 00000000..aecc0655
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py
@@ -0,0 +1,27 @@
+import asyncio
+
+import pandas as pd
+
+from apify_client import ApifyClientAsync
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+async def main() -> None:
+ # Initialize the Apify client
+ apify_client = ApifyClientAsync(token=TOKEN)
+ actor_client = apify_client.actor('apify/web-scraper')
+ run_client = actor_client.last_run()
+ dataset_client = run_client.dataset()
+
+ # Load items from last dataset run
+ dataset_data = await dataset_client.list_items()
+
+ # Pass dataset items to Pandas DataFrame
+ data_frame = pd.DataFrame(dataset_data.items)
+
+ print(data_frame.info)
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py
new file mode 100644
index 00000000..a42e074f
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py
@@ -0,0 +1,25 @@
+import pandas as pd
+
+from apify_client import ApifyClient
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+def main() -> None:
+ # Initialize the Apify client
+ apify_client = ApifyClient(token=TOKEN)
+ actor_client = apify_client.actor('apify/web-scraper')
+ run_client = actor_client.last_run()
+ dataset_client = run_client.dataset()
+
+ # Load items from last dataset run
+ dataset_data = dataset_client.list_items()
+
+ # Pass dataset items to Pandas DataFrame
+ data_frame = pd.DataFrame(dataset_data.items)
+
+ print(data_frame.info)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_async.py b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_async.py
new file mode 100644
index 00000000..7a70d444
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_async.py
@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import asyncio
+from typing import TYPE_CHECKING, Any
+
+import httpx
+
+from apify_client import ApifyClientAsync
+from apify_client.http_clients import HttpClientAsync, HttpResponse
+
+if TYPE_CHECKING:
+ from apify_client.types import Timeout
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+class HttpxClientAsync(HttpClientAsync):
+ """Custom async HTTP client using HTTPX library."""
+
+ def __init__(self) -> None:
+ super().__init__()
+ self._client = httpx.AsyncClient()
+
+ async def call(
+ self,
+ *,
+ method: str,
+ url: str,
+ headers: dict[str, str] | None = None,
+ params: dict[str, Any] | None = None,
+ data: str | bytes | bytearray | None = None,
+ json: Any = None,
+ stream: bool | None = None,
+ timeout: Timeout = 'medium',
+ ) -> HttpResponse:
+ timeout_secs = self._compute_timeout(timeout, attempt=1) or 0
+
+ # httpx.Response satisfies the HttpResponse protocol,
+ # so it can be returned directly.
+ return await self._client.request(
+ method=method,
+ url=url,
+ headers=headers,
+ params=params,
+ content=data,
+ json=json,
+ timeout=timeout_secs,
+ )
+
+
+async def main() -> None:
+ client = ApifyClientAsync.with_custom_http_client(
+ token=TOKEN,
+ http_client=HttpxClientAsync(),
+ )
+
+ actor = await client.actor('apify/hello-world').get()
+ print(actor)
+
+
+if __name__ == '__main__':
+ asyncio.run(main())
diff --git a/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_sync.py b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_sync.py
new file mode 100644
index 00000000..ca499e50
--- /dev/null
+++ b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_sync.py
@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import httpx
+
+from apify_client import ApifyClient
+from apify_client.http_clients import HttpClient, HttpResponse
+
+if TYPE_CHECKING:
+ from apify_client.types import Timeout
+
+TOKEN = 'MY-APIFY-TOKEN'
+
+
+class HttpxClient(HttpClient):
+ """Custom HTTP client using HTTPX library."""
+
+ def __init__(self) -> None:
+ super().__init__()
+ self._client = httpx.Client()
+
+ def call(
+ self,
+ *,
+ method: str,
+ url: str,
+ headers: dict[str, str] | None = None,
+ params: dict[str, Any] | None = None,
+ data: str | bytes | bytearray | None = None,
+ json: Any = None,
+ stream: bool | None = None,
+ timeout: Timeout = 'medium',
+ ) -> HttpResponse:
+ timeout_secs = self._compute_timeout(timeout, attempt=1) or 0
+
+ # httpx.Response satisfies the HttpResponse protocol,
+ # so it can be returned directly.
+ return self._client.request(
+ method=method,
+ url=url,
+ headers=headers,
+ params=params,
+ content=data,
+ json=json,
+ timeout=timeout_secs,
+ )
+
+
+def main() -> None:
+ client = ApifyClient.with_custom_http_client(
+ token=TOKEN,
+ http_client=HttpxClient(),
+ )
+
+ actor = client.actor('apify/hello-world').get()
+ print(actor)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx
new file mode 100644
index 00000000..ed02202b
--- /dev/null
+++ b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx
@@ -0,0 +1,46 @@
+---
+id: upgrading-to-v2
+title: Upgrading to v2
+description: Breaking changes and migration guide from v1 to v2.
+---
+
+import ApiLink from '@theme/ApiLink';
+
+This page summarizes the breaking changes between Apify Python API Client v1.x and v2.0.
+
+## Python version support
+
+Support for Python 3.9 has been dropped. The Apify Python API Client v2.x now requires Python 3.10 or later. Make sure your environment is running a compatible version before upgrading.
+
+## New underlying HTTP library
+
+In v2.0, the Apify Python API client switched from using [`httpx`](https://www.python-httpx.org/) to [`impit`](https://github.com/apify/impit) as the underlying HTTP library. However, this change shouldn't have much impact on the end user.
+
+## API method changes
+
+Several public methods have changed their signatures or behavior.
+
+### Removed parameters and attributes
+
+- The `parse_response` parameter has been removed from the `HTTPClient.call()` method. This was an internal parameter that added a private attribute to the `Response` object.
+- The private `_maybe_parsed_body` attribute has been removed from the `Response` object.
+
+### KeyValueStoreClient
+
+- The deprecated parameters `as_bytes` and `as_file` have been removed from `KeyValueStoreClient.get_record()`. Use the dedicated methods `get_record_as_bytes()` and `stream_record()` instead.
+
+### DatasetClient
+
+- The `unwind` parameter no longer accepts a single string value. Use a list of strings instead: `unwind=['items']` rather than `unwind='items'`.
+
+## Module reorganization
+
+Some modules have been restructured.
+
+### Constants
+
+- Deprecated constant re-exports from `consts.py` have been removed. Constants should now be imported from the [apify-shared-python](https://github.com/apify/apify-shared-python) package if needed.
+
+### Errors
+
+- Error classes are now accessible from the public `apify_client.errors` module. See the `ApifyApiError` API reference for a complete list of available error classes.
diff --git a/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v3.mdx b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v3.mdx
new file mode 100644
index 00000000..7dc8617d
--- /dev/null
+++ b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v3.mdx
@@ -0,0 +1,120 @@
+---
+id: upgrading-to-v3
+title: Upgrading to v3
+description: Breaking changes and migration guide from v2 to v3.
+---
+
+import ApiLink from '@theme/ApiLink';
+
+This guide lists the breaking changes between Apify Python API Client v2.x and v3.0.
+
+## Python 3.11+ required
+
+Support for Python 3.10 has been dropped. The Apify Python API Client v3.x now requires Python 3.11 or later — make sure your environment is on a compatible version before upgrading.
+
+## Typed responses
+
+Methods now return [Pydantic](https://docs.pydantic.dev/latest/) models instead of dicts. Access fields with their snake_case attribute names.
+
+```python
+run = client.actor('apify/hello-world').call(run_input={'key': 'value'})
+
+# Before
+dataset_id = run['defaultDatasetId']
+
+# After
+dataset_id = run.default_dataset_id
+```
+
+Two endpoints still return plain types because their payloads are user-defined: `DatasetClient.list_items()` returns `DatasetItemsPage` (with `items: list[dict[str, Any]]` following the [Actor output schema](https://docs.apify.com/platform/actors/development/actor-definition/output-schema)), and `KeyValueStoreClient.get_record()` returns a `dict`.
+
+On the input side, methods now also accept Pydantic models in addition to dicts. Plain dicts continue to work — keys may use either snake_case or camelCase, and each input shape has a matching [`TypedDict`](https://docs.python.org/3/library/typing.html#typing.TypedDict) so editors and type checkers can validate the keys. See [Typed models](/docs/concepts/typed-models) for details.
+
+## Tiered timeouts
+
+The single global timeout has been replaced by four tiers — `short` (5 s), `medium` (30 s), `long` (360 s), and `no_timeout`. Each method picks an appropriate default. Override per call, or change tier defaults on the constructor:
+
+```python
+from datetime import timedelta
+
+client = ApifyClient(token='MY-APIFY-TOKEN', timeout_short=timedelta(seconds=10))
+
+# Per-call override.
+client.actor('apify/hello-world').get(timeout='long')
+client.actor('apify/hello-world').get(timeout=timedelta(seconds=120))
+```
+
+If your code relied on the previous global timeout, review the methods you use. See [Timeouts](/docs/concepts/timeouts) for the full reference.
+
+## 404 raises NotFoundError on ambiguous endpoints
+
+Direct `.get(id)` and `.delete(id)` calls still swallow 404 into `None`. But where a 404 could mean either the parent or the sub-resource is missing, the client now raises `NotFoundError` instead of returning `None`.
+
+```python
+from apify_client.errors import NotFoundError
+
+# Before — returned None on 404.
+dataset = client.run('some-run-id').dataset().get()
+
+# After — raises NotFoundError; handle it explicitly.
+try:
+ dataset = client.run('some-run-id').dataset().get()
+except NotFoundError:
+ dataset = None
+```
+
+Affected paths:
+
+- Chained calls that target a default sub-resource without an ID — `run.dataset()`, `run.key_value_store()`, `run.request_queue()`, `run.log()`.
+- Chained `LogClient` reads — `run.log().get()`, `.get_as_bytes()`, `.stream()`.
+- Singleton endpoints fetched via a fixed path — `ScheduleClient.get_log()`, `TaskClient.get_input()`, `DatasetClient.get_statistics()`, `UserClient.monthly_usage()`, `UserClient.limits()`, `WebhookClient.test()`. Their return types changed from `T | None` to `T`.
+
+Status-specific subclasses such as `RateLimitError` are now available too — see [Error handling](/docs/concepts/error-handling#error-subclasses). Existing `except ApifyApiError` handlers are unaffected.
+
+## Keyword-only arguments
+
+Secondary parameters on these methods can no longer be passed positionally.
+
+```python
+# Before
+client.key_value_store('my-store').set_record('my-key', {'data': 1}, 'application/json')
+client.run('my-run').charge('my-event', 5, 'my-idempotency-key')
+
+# After
+client.key_value_store('my-store').set_record('my-key', {'data': 1}, content_type='application/json')
+client.run('my-run').charge('my-event', count=5, idempotency_key='my-idempotency-key')
+```
+
+Affected signatures:
+
+- `KeyValueStoreClient` — `get_record`, `get_record_as_bytes`, `stream_record`, `set_record`.
+- `RunClient` — `charge`, `get_status_message_watcher`.
+- `ApifyApiError` constructor — `method` is keyword-only.
+
+## Literal string aliases instead of StrEnum classes
+
+Generated enum-like types are now [`Literal`](https://docs.python.org/3/library/typing.html#typing.Literal) string aliases instead of `StrEnum` classes. Pass plain strings instead of enum members; type checkers infer the allowed set directly from each method signature, so nothing needs to be imported for argument validation.
+
+```python
+# Before
+event_types=[WebhookEventType.ACTOR_RUN_SUCCEEDED]
+
+# After
+event_types=['ACTOR.RUN.SUCCEEDED']
+```
+
+Affected types: `ActorJobStatus`, `ActorPermissionLevel`, `ErrorType`, `GeneralAccess`, `HttpMethod`, `RunOrigin`, `SourceCodeFileFormat`, `StorageOwnership`, `VersionSourceType`, `WebhookDispatchStatus`, `WebhookEventType`. For more on the generated types and how they fit into the typed client surface, see [Typed models](/docs/concepts/typed-models).
+
+## Async iterate_* are no longer coroutine functions
+
+`DatasetClientAsync.iterate_items()` and `KeyValueStoreClientAsync.iterate_keys()` are now plain `def` functions returning `AsyncIterator[T]`. Consumer code (`async for ...`) is unchanged. If you annotate the call's return value, change `AsyncGenerator[T, None]` to `AsyncIterator[T]`. For background on these helpers and how they fit alongside page models, see [Pagination](/docs/concepts/pagination).
+
+## Removed deprecated APIs
+
+- `DatasetClient.download_items()` → use `DatasetClient.get_items_as_bytes()` (identical signature).
+- `max_unprocessed_requests_retries` and `min_delay_between_unprocessed_requests_retries` on `RequestQueueClient.batch_add_requests()` — were no-ops; drop them.
+- `exclusive_start_id` on `RequestQueueClient.list_requests()` → use `cursor` with `next_cursor` from the previous response, or `iterate_requests()`.
+
+## Pluggable HTTP client
+
+Additive change, non-breaking. The HTTP layer is now abstracted behind the `HttpClient` and `HttpClientAsync` base classes, so you can swap the underlying transport for your own implementation. The default client built on [Impit](https://github.com/apify/impit) is unchanged and existing code keeps working out of the box. To plug in a custom client, pass an instance to `ApifyClient.with_custom_http_client()` — see [Custom HTTP clients](/docs/concepts/custom-http-clients) for the full walkthrough.
diff --git a/website/versioned_docs/version-3.0/api-packages.json b/website/versioned_docs/version-3.0/api-packages.json
new file mode 100644
index 00000000..2730ed49
--- /dev/null
+++ b/website/versioned_docs/version-3.0/api-packages.json
@@ -0,0 +1 @@
+[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":".","packagePath":".","packageSlug":".","packageName":"apify-client-python-website"}]
\ No newline at end of file
diff --git a/website/versioned_docs/version-3.0/api-typedoc.json b/website/versioned_docs/version-3.0/api-typedoc.json
new file mode 100644
index 00000000..ff42ba57
--- /dev/null
+++ b/website/versioned_docs/version-3.0/api-typedoc.json
@@ -0,0 +1,175593 @@
+{
+ "children": [
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total number of API method calls made by the client."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2,
+ "module": "_statistics",
+ "name": "calls",
+ "parsedDocstring": {
+ "text": "Total number of API method calls made by the client."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_statistics.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 11
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total number of HTTP requests sent, including retries."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 3,
+ "module": "_statistics",
+ "name": "requests",
+ "parsedDocstring": {
+ "text": "Total number of HTTP requests sent, including retries."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_statistics.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 14
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List tracking which retry attempts encountered rate limit (429) errors."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4,
+ "module": "_statistics",
+ "name": "rate_limit_errors",
+ "parsedDocstring": {
+ "text": "List tracking which retry attempts encountered rate limit (429) errors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_statistics.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 17
+ }
+ ],
+ "type": {
+ "name": "defaultdict",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add rate limit error for specific attempt.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 5,
+ "module": "_statistics",
+ "name": "add_rate_limit_error",
+ "parsedDocstring": {
+ "text": "Add rate limit error for specific attempt.\n",
+ "args": {
+ "attempt": "The attempt number (1-based indexing)."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_statistics.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add rate limit error for specific attempt.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 6,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "add_rate_limit_error",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number (1-based indexing)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 7,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics about API client usage and rate limit errors."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "dataclass"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 5
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 2,
+ 4,
+ 3
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1,
+ "module": "_statistics",
+ "name": "ClientStatistics",
+ "parsedDocstring": {
+ "text": "Statistics about API client usage and rate limit errors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_statistics.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 8
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 8,
+ "module": "_docs",
+ "name": "GroupName",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_docs.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 8
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 9,
+ "module": "_docs",
+ "name": "T",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_docs.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 18
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 10,
+ "module": "_docs",
+ "name": "docs_group",
+ "parsedDocstring": {
+ "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n",
+ "args": {
+ "group_name": "The documentation group to which the symbol belongs.\n"
+ },
+ "returns": "The original callable without modification."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_docs.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The original callable without modification."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 11,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "docs_group",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The documentation group to which the symbol belongs.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 12,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "group_name",
+ "type": {
+ "name": "GroupName",
+ "type": "reference",
+ "target": "8"
+ }
+ }
+ ],
+ "type": {
+ "name": "Callable",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "[T]"
+ },
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 13,
+ "module": "types",
+ "name": "Timeout",
+ "parsedDocstring": {
+ "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/types.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 14
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 14,
+ "module": "types",
+ "name": "WebhooksList",
+ "parsedDocstring": {
+ "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/types.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 15,
+ "module": "types",
+ "name": "JsonSerializable",
+ "parsedDocstring": {
+ "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/types.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class for all Apify API client errors."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 16,
+ "module": "errors",
+ "name": "ApifyClientError",
+ "parsedDocstring": {
+ "text": "Base class for all Apify API client errors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 15
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ },
+ {
+ "name": "InvalidResponseBodyError",
+ "target": "35",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 18,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 23,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 23,
+ 18
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 17,
+ "module": "errors",
+ "name": "ApifyApiError",
+ "parsedDocstring": {
+ "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyClientError",
+ "target": "16",
+ "type": "reference"
+ }
+ ],
+ "extendedBy": [
+ {
+ "name": "InvalidRequestError",
+ "target": "28",
+ "type": "reference"
+ },
+ {
+ "name": "UnauthorizedError",
+ "target": "29",
+ "type": "reference"
+ },
+ {
+ "name": "ForbiddenError",
+ "target": "30",
+ "type": "reference"
+ },
+ {
+ "name": "NotFoundError",
+ "target": "31",
+ "type": "reference"
+ },
+ {
+ "name": "ConflictError",
+ "target": "32",
+ "type": "reference"
+ },
+ {
+ "name": "RateLimitError",
+ "target": "33",
+ "type": "reference"
+ },
+ {
+ "name": "ServerError",
+ "target": "34",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4272,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4273,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 400 Bad Request response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4273,
+ 4272
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 28,
+ "module": "errors",
+ "name": "InvalidRequestError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 400 Bad Request response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 94
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4274,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4275,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4275,
+ 4274
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 29,
+ "module": "errors",
+ "name": "UnauthorizedError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 99
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4276,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4277,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 403 Forbidden response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4277,
+ 4276
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 30,
+ "module": "errors",
+ "name": "ForbiddenError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 403 Forbidden response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 104
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4278,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4279,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 404 Not Found response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4279,
+ 4278
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 31,
+ "module": "errors",
+ "name": "NotFoundError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 404 Not Found response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4280,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4281,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 409 Conflict response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4281,
+ 4280
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 32,
+ "module": "errors",
+ "name": "ConflictError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 409 Conflict response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 114
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4282,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4283,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4283,
+ 4282
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 33,
+ "module": "errors",
+ "name": "RateLimitError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 119
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4284,
+ "module": "errors",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Dispatch to the subclass matching the response's HTTP status code, if any."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 19,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 20,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 21,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 22,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__new__",
+ "target": 18,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4285,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the API error from a failed response.\n",
+ "args": {
+ "response": "The failed HTTP response from the Apify API.",
+ "attempt": "The attempt number when the request failed (1-indexed).",
+ "method": "The HTTP method of the failed request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the API error from a failed response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 24,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The failed HTTP response from the Apify API."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 25,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The attempt number when the request failed (1-indexed)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 26,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attempt",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP method of the failed request."
+ }
+ ]
+ },
+ "defaultValue": "'GET'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 27,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "ApifyApiError.__init__",
+ "target": 23,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4285,
+ 4284
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 34,
+ "module": "errors",
+ "name": "ServerError",
+ "parsedDocstring": {
+ "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 128
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyApiError",
+ "target": "17",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the error from an unparsable response.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 36,
+ "module": "errors",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the error from an unparsable response.\n",
+ "args": {
+ "response": "The HTTP response whose body could not be parsed."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 144
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the error from an unparsable response.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 37,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP response whose body could not be parsed."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 38,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Errors')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 36
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 35,
+ "module": "errors",
+ "name": "InvalidResponseBodyError",
+ "parsedDocstring": {
+ "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/errors.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 136
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ApifyClientError",
+ "target": "16",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 40,
+ "module": "_streamed_log",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "flags": {},
+ "id": 41,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 42,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "True",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 43,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "from_start",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class for streaming and buffering chunked Actor run logs."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 40
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 39,
+ "module": "_streamed_log",
+ "name": "StreamedLogBase",
+ "parsedDocstring": {
+ "text": "Base class for streaming and buffering chunked Actor run logs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "StreamedLog",
+ "target": "44",
+ "type": "reference"
+ },
+ {
+ "name": "StreamedLogAsync",
+ "target": "61",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StreamedLog`.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 45,
+ "module": "_streamed_log",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize `StreamedLog`.\n",
+ "args": {
+ "log_client": "The log client used to stream raw log data from the Actor run.",
+ "to_logger": "The logger to which the log messages will be forwarded.",
+ "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 97
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StreamedLog`.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 46,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The log client used to stream raw log data from the Actor run."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 47,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "log_client",
+ "type": {
+ "name": "LogClient",
+ "type": "reference",
+ "target": "2258"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The logger to which the log messages will be forwarded."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 48,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant."
+ }
+ ]
+ },
+ "defaultValue": "True",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 49,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "from_start",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "StreamedLogBase.__init__",
+ "target": 40,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "StreamedLogBase.__init__",
+ "target": 40,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 50,
+ "module": "_streamed_log",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 112
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 51,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "start",
+ "parameters": [],
+ "type": {
+ "name": "Thread",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signal the streaming thread to stop logging and wait for it to finish."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 52,
+ "module": "_streamed_log",
+ "name": "stop",
+ "parsedDocstring": {
+ "text": "Signal the streaming thread to stop logging and wait for it to finish."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 124
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signal the streaming thread to stop logging and wait for it to finish."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 53,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "stop",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 54,
+ "module": "_streamed_log",
+ "name": "__enter__",
+ "parsedDocstring": {
+ "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 133
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 55,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__enter__",
+ "parameters": [],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the streaming thread."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 56,
+ "module": "_streamed_log",
+ "name": "__exit__",
+ "parsedDocstring": {
+ "text": "Stop the streaming thread."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 138
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the streaming thread."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 57,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__exit__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 58,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_type",
+ "type": {
+ "name": "type[BaseException] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "type",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ }
+ ],
+ "target": "524"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 59,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_val",
+ "type": {
+ "name": "BaseException | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 60,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_tb",
+ "type": {
+ "name": "TracebackType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TracebackType"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Other')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 54,
+ 56,
+ 45,
+ 50,
+ 52
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 44,
+ "module": "_streamed_log",
+ "name": "StreamedLog",
+ "parsedDocstring": {
+ "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 83
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "StreamedLogBase",
+ "target": "39",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StreamedLogAsync`.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 62,
+ "module": "_streamed_log",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize `StreamedLogAsync`.\n",
+ "args": {
+ "log_client": "The async log client used to stream raw log data from the Actor run.",
+ "to_logger": "The logger to which the log messages will be forwarded.",
+ "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 169
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StreamedLogAsync`.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 63,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The async log client used to stream raw log data from the Actor run."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 64,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "log_client",
+ "type": {
+ "name": "LogClientAsync",
+ "type": "reference",
+ "target": "2275"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The logger to which the log messages will be forwarded."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 65,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant."
+ }
+ ]
+ },
+ "defaultValue": "True",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 66,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "from_start",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "StreamedLogBase.__init__",
+ "target": 40,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "StreamedLogBase.__init__",
+ "target": 40,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 67,
+ "module": "_streamed_log",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 183
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 68,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "start",
+ "parameters": [],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the streaming task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 69,
+ "module": "_streamed_log",
+ "name": "stop",
+ "parsedDocstring": {
+ "text": "Stop the streaming task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 193
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the streaming task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 70,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "stop",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 71,
+ "module": "_streamed_log",
+ "name": "__aenter__",
+ "parsedDocstring": {
+ "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 206
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 72,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "__aenter__",
+ "parameters": [],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Cancel the streaming task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 73,
+ "module": "_streamed_log",
+ "name": "__aexit__",
+ "parsedDocstring": {
+ "text": "Cancel the streaming task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 211
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Cancel the streaming task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 74,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "__aexit__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 75,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_type",
+ "type": {
+ "name": "type[BaseException] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "type",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ }
+ ],
+ "target": "524"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 76,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_val",
+ "type": {
+ "name": "BaseException | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 77,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_tb",
+ "type": {
+ "name": "TracebackType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TracebackType"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Other')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 71,
+ 73,
+ 62,
+ 67,
+ 69
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 61,
+ "module": "_streamed_log",
+ "name": "StreamedLogAsync",
+ "parsedDocstring": {
+ "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_streamed_log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 159
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "StreamedLogBase",
+ "target": "39",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 79,
+ "module": "_typeddicts",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 12
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 80,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 16
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 81,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 82,
+ "module": "_typeddicts",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 83,
+ "module": "_typeddicts",
+ "name": "loaded_url",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 84,
+ "module": "_typeddicts",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 85,
+ "module": "_typeddicts",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 86,
+ "module": "_typeddicts",
+ "name": "user_data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 87,
+ "module": "_typeddicts",
+ "name": "no_retry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 88,
+ "module": "_typeddicts",
+ "name": "error_messages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 89,
+ "module": "_typeddicts",
+ "name": "handled_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 88,
+ 89,
+ 85,
+ 83,
+ 81,
+ 87,
+ 84,
+ 82,
+ 79,
+ 80,
+ 86
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 78,
+ "module": "_typeddicts",
+ "name": "RequestBaseDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 11
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "RequestDict",
+ "target": "102",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 91,
+ "module": "_typeddicts",
+ "name": "uniqueKey",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 92,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 58
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 93,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 62
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 94,
+ "module": "_typeddicts",
+ "name": "retryCount",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 95,
+ "module": "_typeddicts",
+ "name": "loadedUrl",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 96,
+ "module": "_typeddicts",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 71
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 97,
+ "module": "_typeddicts",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 98,
+ "module": "_typeddicts",
+ "name": "userData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 79
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 99,
+ "module": "_typeddicts",
+ "name": "noRetry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 80
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 100,
+ "module": "_typeddicts",
+ "name": "errorMessages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 84
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 101,
+ "module": "_typeddicts",
+ "name": "handledAt",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 88
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 100,
+ 101,
+ 97,
+ 95,
+ 93,
+ 99,
+ 96,
+ 94,
+ 91,
+ 92,
+ 98
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 90,
+ "module": "_typeddicts",
+ "name": "RequestBaseCamelDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 53
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "RequestCamelDict",
+ "target": "104",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 103,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 98
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4261,
+ "module": "_typeddicts",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 12
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.unique_key",
+ "target": 79,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4262,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 16
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.url",
+ "target": 80,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4263,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.method",
+ "target": 81,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4264,
+ "module": "_typeddicts",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "NotRequired[int]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.retry_count",
+ "target": 82,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4265,
+ "module": "_typeddicts",
+ "name": "loaded_url",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.loaded_url",
+ "target": 83,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4266,
+ "module": "_typeddicts",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | dict[str, Any] | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.payload",
+ "target": 84,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4267,
+ "module": "_typeddicts",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "NotRequired[dict[str, Any] | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.headers",
+ "target": 85,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4268,
+ "module": "_typeddicts",
+ "name": "user_data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.user_data",
+ "target": 86,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4269,
+ "module": "_typeddicts",
+ "name": "no_retry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "NotRequired[bool | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.no_retry",
+ "target": 87,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4270,
+ "module": "_typeddicts",
+ "name": "error_messages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "NotRequired[list[str]]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.error_messages",
+ "target": 88,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4271,
+ "module": "_typeddicts",
+ "name": "handled_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseDict.handled_at",
+ "target": 89,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4270,
+ 4271,
+ 4267,
+ 103,
+ 4265,
+ 4263,
+ 4269,
+ 4266,
+ 4264,
+ 4261,
+ 4262,
+ 4268
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 102,
+ "module": "_typeddicts",
+ "name": "RequestDict",
+ "parsedDocstring": {
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 95
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "RequestBaseDict",
+ "target": "78",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 105,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 108
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4250,
+ "module": "_typeddicts",
+ "name": "uniqueKey",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.uniqueKey",
+ "target": 91,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4251,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 58
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.url",
+ "target": 92,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4252,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 62
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.method",
+ "target": 93,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4253,
+ "module": "_typeddicts",
+ "name": "retryCount",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "NotRequired[int]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.retryCount",
+ "target": 94,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4254,
+ "module": "_typeddicts",
+ "name": "loadedUrl",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.loadedUrl",
+ "target": 95,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4255,
+ "module": "_typeddicts",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 71
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | dict[str, Any] | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.payload",
+ "target": 96,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4256,
+ "module": "_typeddicts",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "NotRequired[dict[str, Any] | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.headers",
+ "target": 97,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4257,
+ "module": "_typeddicts",
+ "name": "userData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 79
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.userData",
+ "target": 98,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4258,
+ "module": "_typeddicts",
+ "name": "noRetry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 80
+ }
+ ],
+ "type": {
+ "name": "NotRequired[bool | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.noRetry",
+ "target": 99,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4259,
+ "module": "_typeddicts",
+ "name": "errorMessages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 84
+ }
+ ],
+ "type": {
+ "name": "NotRequired[list[str]]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.errorMessages",
+ "target": 100,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4260,
+ "module": "_typeddicts",
+ "name": "handledAt",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 88
+ }
+ ],
+ "type": {
+ "name": "NotRequired[str | None]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBaseCamelDict.handledAt",
+ "target": 101,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4259,
+ 4260,
+ 4256,
+ 105,
+ 4254,
+ 4252,
+ 4258,
+ 4255,
+ 4253,
+ 4250,
+ 4251,
+ 4257
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 104,
+ "module": "_typeddicts",
+ "name": "RequestCamelDict",
+ "parsedDocstring": {
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 105
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "RequestBaseCamelDict",
+ "target": "90",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 107,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 118
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 108,
+ "module": "_typeddicts",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 122
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 109,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 126
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 110,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 130
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 107,
+ 110,
+ 108,
+ 109
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 106,
+ "module": "_typeddicts",
+ "name": "RequestDraftDict",
+ "parsedDocstring": {
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 112,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 137
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 113,
+ "module": "_typeddicts",
+ "name": "uniqueKey",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 141
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 114,
+ "module": "_typeddicts",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 145
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 115,
+ "module": "_typeddicts",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 149
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "GET"
+ },
+ {
+ "type": "literal",
+ "value": "HEAD"
+ },
+ {
+ "type": "literal",
+ "value": "POST"
+ },
+ {
+ "type": "literal",
+ "value": "PUT"
+ },
+ {
+ "type": "literal",
+ "value": "DELETE"
+ },
+ {
+ "type": "literal",
+ "value": "CONNECT"
+ },
+ {
+ "type": "literal",
+ "value": "OPTIONS"
+ },
+ {
+ "type": "literal",
+ "value": "TRACE"
+ },
+ {
+ "type": "literal",
+ "value": "PATCH"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 112,
+ 115,
+ 113,
+ 114
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 111,
+ "module": "_typeddicts",
+ "name": "RequestDraftCamelDict",
+ "parsedDocstring": {
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 134
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 117,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 156
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 118,
+ "module": "_typeddicts",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 160
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 117,
+ 118
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 116,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteByIdDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 153
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 120,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 170
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 121,
+ "module": "_typeddicts",
+ "name": "uniqueKey",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 174
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 120,
+ 121
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 119,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteByIdCamelDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 167
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 123,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 184
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 124,
+ "module": "_typeddicts",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 188
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its unique key."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 123,
+ 124
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 122,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteByUniqueKeyDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its unique key."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 181
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 126,
+ "module": "_typeddicts",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 198
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 127,
+ "module": "_typeddicts",
+ "name": "uniqueKey",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 202
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its unique key."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 126,
+ 127
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 125,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteByUniqueKeyCamelDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its unique key."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 195
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 128,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 208
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 129,
+ "module": "_typeddicts",
+ "name": "RequestDraftDeleteCamelDict",
+ "parsedDocstring": {
+ "text": "A request that should be deleted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 213
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 130,
+ "module": "_typeddicts",
+ "name": "RequestUserDataDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 219
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 131,
+ "module": "_typeddicts",
+ "name": "RequestUserDataCamelDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 221
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 132,
+ "module": "_typeddicts",
+ "name": "TaskInputDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 224
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 133,
+ "module": "_typeddicts",
+ "name": "TaskInputCamelDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 226
+ }
+ ],
+ "type": {
+ "name": "TypeAlias",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 135,
+ "module": "_typeddicts",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 231
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 136,
+ "module": "_typeddicts",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 232
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 137,
+ "module": "_typeddicts",
+ "name": "actor_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 233
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 135,
+ 137,
+ 136
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 134,
+ "module": "_typeddicts",
+ "name": "WebhookConditionDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 230
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 139,
+ "module": "_typeddicts",
+ "name": "actorId",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 238
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 140,
+ "module": "_typeddicts",
+ "name": "actorTaskId",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 239
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 141,
+ "module": "_typeddicts",
+ "name": "actorRunId",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 240
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 139,
+ 141,
+ 140
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 138,
+ "module": "_typeddicts",
+ "name": "WebhookConditionCamelDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 237
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 143,
+ "module": "_typeddicts",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 245
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 144,
+ "module": "_typeddicts",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 246
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.RESURRECTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "TEST"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 145,
+ "module": "_typeddicts",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 262
+ }
+ ],
+ "type": {
+ "name": "WebhookConditionDict",
+ "type": "reference",
+ "target": "134"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 146,
+ "module": "_typeddicts",
+ "name": "idempotency_key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 263
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 147,
+ "module": "_typeddicts",
+ "name": "ignore_ssl_errors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 264
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 148,
+ "module": "_typeddicts",
+ "name": "do_not_retry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 265
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 149,
+ "module": "_typeddicts",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 266
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 150,
+ "module": "_typeddicts",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 267
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 151,
+ "module": "_typeddicts",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 268
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 152,
+ "module": "_typeddicts",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 269
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 153,
+ "module": "_typeddicts",
+ "name": "should_interpolate_strings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 270
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 145,
+ 152,
+ 148,
+ 144,
+ 151,
+ 146,
+ 147,
+ 143,
+ 150,
+ 149,
+ 153
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 142,
+ "module": "_typeddicts",
+ "name": "WebhookCreateDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 244
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 155,
+ "module": "_typeddicts",
+ "name": "isAdHoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 275
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 156,
+ "module": "_typeddicts",
+ "name": "eventTypes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 276
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.RESURRECTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "TEST"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 157,
+ "module": "_typeddicts",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 292
+ }
+ ],
+ "type": {
+ "name": "WebhookConditionCamelDict",
+ "type": "reference",
+ "target": "138"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 158,
+ "module": "_typeddicts",
+ "name": "idempotencyKey",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 293
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 159,
+ "module": "_typeddicts",
+ "name": "ignoreSslErrors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 294
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 160,
+ "module": "_typeddicts",
+ "name": "doNotRetry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 295
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 161,
+ "module": "_typeddicts",
+ "name": "requestUrl",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 296
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 162,
+ "module": "_typeddicts",
+ "name": "payloadTemplate",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 297
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 163,
+ "module": "_typeddicts",
+ "name": "headersTemplate",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 298
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 164,
+ "module": "_typeddicts",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 299
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 165,
+ "module": "_typeddicts",
+ "name": "shouldInterpolateStrings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 300
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 157,
+ 164,
+ 160,
+ 156,
+ 163,
+ 158,
+ 159,
+ 155,
+ 162,
+ 161,
+ 165
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 154,
+ "module": "_typeddicts",
+ "name": "WebhookCreateCamelDict",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 274
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 167,
+ "module": "_typeddicts",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 311
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.RESURRECTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "TEST"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL to which the webhook sends its payload."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 168,
+ "module": "_typeddicts",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": "The URL to which the webhook sends its payload."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 327
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the JSON payload sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 169,
+ "module": "_typeddicts",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": "Optional template for the JSON payload sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 331
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 170,
+ "module": "_typeddicts",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 335
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 167,
+ 170,
+ 169,
+ 168
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 166,
+ "module": "_typeddicts",
+ "name": "WebhookRepresentationDict",
+ "parsedDocstring": {
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 304
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 172,
+ "module": "_typeddicts",
+ "name": "eventTypes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 349
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.BUILD.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.ABORTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.CREATED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.FAILED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.RESURRECTED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.SUCCEEDED"
+ },
+ {
+ "type": "literal",
+ "value": "ACTOR.RUN.TIMED_OUT"
+ },
+ {
+ "type": "literal",
+ "value": "TEST"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL to which the webhook sends its payload."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 173,
+ "module": "_typeddicts",
+ "name": "requestUrl",
+ "parsedDocstring": {
+ "text": "The URL to which the webhook sends its payload."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 365
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the JSON payload sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 174,
+ "module": "_typeddicts",
+ "name": "payloadTemplate",
+ "parsedDocstring": {
+ "text": "Optional template for the JSON payload sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 369
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 175,
+ "module": "_typeddicts",
+ "name": "headersTemplate",
+ "parsedDocstring": {
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 373
+ }
+ ],
+ "type": {
+ "name": "NotRequired",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Typed dicts')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 172,
+ 175,
+ 174,
+ 173
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 171,
+ "module": "_typeddicts",
+ "name": "WebhookRepresentationCamelDict",
+ "parsedDocstring": {
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_typeddicts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 342
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default base URL for the Apify API."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 176,
+ "module": "_consts",
+ "name": "DEFAULT_API_URL",
+ "parsedDocstring": {
+ "text": "Default base URL for the Apify API."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 5
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Current Apify API version."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 177,
+ "module": "_consts",
+ "name": "API_VERSION",
+ "parsedDocstring": {
+ "text": "Current Apify API version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 8
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 178,
+ "module": "_consts",
+ "name": "DEFAULT_TIMEOUT_SHORT",
+ "parsedDocstring": {
+ "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 11
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for batch, list, and data transfer operations."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 179,
+ "module": "_consts",
+ "name": "DEFAULT_TIMEOUT_MEDIUM",
+ "parsedDocstring": {
+ "text": "Default timeout for batch, list, and data transfer operations."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 14
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-polling, streaming, and other heavy operations."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 180,
+ "module": "_consts",
+ "name": "DEFAULT_TIMEOUT_LONG",
+ "parsedDocstring": {
+ "text": "Default timeout for long-polling, streaming, and other heavy operations."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 17
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default maximum timeout cap for individual API requests (limits exponential growth)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 181,
+ "module": "_consts",
+ "name": "DEFAULT_TIMEOUT_MAX",
+ "parsedDocstring": {
+ "text": "Default maximum timeout cap for individual API requests (limits exponential growth)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default maximum number of retries for failed requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 182,
+ "module": "_consts",
+ "name": "DEFAULT_MAX_RETRIES",
+ "parsedDocstring": {
+ "text": "Default maximum number of retries for failed requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 23
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default minimum delay between retries."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 183,
+ "module": "_consts",
+ "name": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "parsedDocstring": {
+ "text": "Default minimum delay between retries."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default maximum wait time for job completion (effectively infinite)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 184,
+ "module": "_consts",
+ "name": "DEFAULT_WAIT_FOR_FINISH",
+ "parsedDocstring": {
+ "text": "Default maximum wait time for job completion (effectively infinite)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long to wait for a job to exist before giving up."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 185,
+ "module": "_consts",
+ "name": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST",
+ "parsedDocstring": {
+ "text": "How long to wait for a job to exist before giving up."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 186,
+ "module": "_consts",
+ "name": "OVERRIDABLE_DEFAULT_HEADERS",
+ "parsedDocstring": {
+ "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_consts.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 35
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 188,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 189,
+ "module": "_models",
+ "name": "monthly_usage_cycle",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 30
+ }
+ ],
+ "type": {
+ "name": "UsageCycle",
+ "type": "reference",
+ "target": "1391"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 190,
+ "module": "_models",
+ "name": "limits",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Limits",
+ "type": "reference",
+ "target": "684"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 191,
+ "module": "_models",
+ "name": "current",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "Current",
+ "type": "reference",
+ "target": "443"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 191,
+ 190,
+ 188,
+ 189
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 187,
+ "module": "_models",
+ "name": "AccountLimits",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 193,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 39
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 194,
+ "module": "_models",
+ "name": "source_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 43
+ }
+ ],
+ "type": {
+ "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "VersionSourceType",
+ "target": "1900"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 195,
+ "module": "_models",
+ "name": "build_tag",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 44
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='buildTag', examples=['experimental'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 196,
+ "module": "_models",
+ "name": "version_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 45
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='versionNumber', examples=['0.0'], pattern='^([0-9]|[1-9][0-9])\\\\.([0-9]|[1-9][0-9])$') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the git repository, present when sourceType is GIT_REPO."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 197,
+ "module": "_models",
+ "name": "git_repo_url",
+ "parsedDocstring": {
+ "text": "URL of the git repository, present when sourceType is GIT_REPO."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 48
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='gitRepoUrl', examples=['https://github.com/apifytech/actor-crawler.git ]",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Inline source files, present when sourceType is SOURCE_FILES."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 198,
+ "module": "_models",
+ "name": "source_files",
+ "parsedDocstring": {
+ "text": "Inline source files, present when sourceType is SOURCE_FILES."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 55
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[SourceCodeFile] | None, Field(alias='sourceFiles')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "SourceCodeFile",
+ "target": "1241"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Snapshot of the Actor version that this build was created from."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 195,
+ 197,
+ 193,
+ 198,
+ 194,
+ 196
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 192,
+ "module": "_models",
+ "name": "ActVersion",
+ "parsedDocstring": {
+ "text": "Snapshot of the Actor version that this build was created from."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 200,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 201,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 202,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 68
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 203,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 69
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 204,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 70
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 205,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 71
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 206,
+ "module": "_models",
+ "name": "restart_on_error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 207,
+ "module": "_models",
+ "name": "is_public",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 73
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 208,
+ "module": "_models",
+ "name": "actor_permission_level",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 74
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 209,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 210,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 76
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 211,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 77
+ }
+ ],
+ "type": {
+ "name": "ActorStats",
+ "type": "reference",
+ "target": "285"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 212,
+ "module": "_models",
+ "name": "versions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 78
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 213,
+ "module": "_models",
+ "name": "pricing_infos",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 79
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "PayPerEventActorPricingInfo",
+ "target": "848"
+ },
+ {
+ "type": "reference",
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "target": "880"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "target": "622"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FreeActorPricingInfo",
+ "target": "627"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 214,
+ "module": "_models",
+ "name": "default_run_options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 92
+ }
+ ],
+ "type": {
+ "name": "DefaultRunOptions",
+ "type": "reference",
+ "target": "550"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 215,
+ "module": "_models",
+ "name": "example_run_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 93
+ }
+ ],
+ "type": {
+ "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ExampleRunInput",
+ "target": "613"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 216,
+ "module": "_models",
+ "name": "is_deprecated",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 94
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isDeprecated', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 217,
+ "module": "_models",
+ "name": "deployment_key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 95
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='deploymentKey', examples=['ssh-rsa AAAA ...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 218,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 96
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My Actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 219,
+ "module": "_models",
+ "name": "tagged_builds",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 97
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, TaggedBuildInfo | None] | None, Field(alias='taggedBuilds')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaggedBuildInfo",
+ "target": "1279"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 220,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 98
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A brief, LLM-generated readme summary"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 221,
+ "module": "_models",
+ "name": "readme_summary",
+ "parsedDocstring": {
+ "text": "A brief, LLM-generated readme summary"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 99
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='readmeSummary')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 222,
+ "module": "_models",
+ "name": "seo_title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 103
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='seoTitle', examples=['Web Scraper'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 223,
+ "module": "_models",
+ "name": "seo_description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 104
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field( alias='seoDescription', examples=['Crawls websites using Chrome and extracts data from pages using JavaScript.'], ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 224,
+ "module": "_models",
+ "name": "picture_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 111
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='pictureUrl', examples=['https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png']), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 225,
+ "module": "_models",
+ "name": "standby_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='standbyUrl', examples=['https://my-actor.apify.actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 226,
+ "module": "_models",
+ "name": "notice",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 116
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['NONE'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 227,
+ "module": "_models",
+ "name": "categories",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 117
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[str] | None, Field(examples=[['DEVELOPER_TOOLS', 'OPEN_SOURCE']])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 228,
+ "module": "_models",
+ "name": "is_critical",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 118
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isCritical', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 229,
+ "module": "_models",
+ "name": "is_generic",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 119
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isGeneric', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 230,
+ "module": "_models",
+ "name": "is_source_code_hidden",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 120
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isSourceCodeHidden', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 231,
+ "module": "_models",
+ "name": "has_no_dataset",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 121
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='hasNoDataset', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 208,
+ 220,
+ 227,
+ 209,
+ 214,
+ 217,
+ 205,
+ 215,
+ 231,
+ 201,
+ 228,
+ 216,
+ 229,
+ 207,
+ 230,
+ 200,
+ 210,
+ 203,
+ 226,
+ 224,
+ 213,
+ 221,
+ 206,
+ 223,
+ 222,
+ 225,
+ 211,
+ 219,
+ 218,
+ 202,
+ 204,
+ 212
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 199,
+ "module": "_models",
+ "name": "Actor",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 62
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 233,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 131
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Human-readable title shown to users in the billing UI."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 234,
+ "module": "_models",
+ "name": "event_title",
+ "parsedDocstring": {
+ "text": "Human-readable title shown to users in the billing UI."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 135
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Human-readable description of what triggers this event."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 235,
+ "module": "_models",
+ "name": "event_description",
+ "parsedDocstring": {
+ "text": "Human-readable description of what triggers this event."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 139
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Flat price per event in USD. Present only for non-tiered events. Mutually exclusive with `eventTieredPricingUsd`."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 236,
+ "module": "_models",
+ "name": "event_price_usd",
+ "parsedDocstring": {
+ "text": "Flat price per event in USD. Present only for non-tiered events. Mutually exclusive with `eventTieredPricingUsd`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 143
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='eventPriceUsd')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 237,
+ "module": "_models",
+ "name": "event_tiered_pricing_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 148
+ }
+ ],
+ "type": {
+ "name": "Annotated[ dict[str, TieredPricingPerEventEntry] | None, Field(alias='eventTieredPricingUsd') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "TieredPricingPerEventEntry",
+ "target": "1335"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether this event is the Actor's primary chargeable event."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 238,
+ "module": "_models",
+ "name": "is_primary_event",
+ "parsedDocstring": {
+ "text": "Whether this event is the Actor's primary chargeable event."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 151
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isPrimaryEvent')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether this event can only be charged once per Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 239,
+ "module": "_models",
+ "name": "is_one_time_event",
+ "parsedDocstring": {
+ "text": "Whether this event can only be charged once per Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 155
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isOneTimeEvent')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Definition of a single chargeable event for a pay-per-event Actor. Each event is either flat-priced\n(`eventPriceUsd` is set) or tier-priced (`eventTieredPricingUsd` is set); the two are mutually exclusive."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 235,
+ 236,
+ 237,
+ 234,
+ 239,
+ 238,
+ 233
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 232,
+ "module": "_models",
+ "name": "ActorChargeEvent",
+ "parsedDocstring": {
+ "text": "Definition of a single chargeable event for a pay-per-event Actor. Each event is either flat-priced\n(`eventPriceUsd` is set) or tier-priced (`eventTieredPricingUsd` is set); the two are mutually exclusive."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 125
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 241,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 165
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Actor specification version that this Actor follows. This property must be set to 1."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 242,
+ "module": "_models",
+ "name": "actor_specification",
+ "parsedDocstring": {
+ "text": "The Actor specification version that this Actor follows. This property must be set to 1."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 169
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": 1
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 243,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": "The name of the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 173
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 244,
+ "module": "_models",
+ "name": "version",
+ "parsedDocstring": {
+ "text": "The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 177
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(pattern='^[0-9]+(\\\\.[0-9]+)+$')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 245,
+ "module": "_models",
+ "name": "build_tag",
+ "parsedDocstring": {
+ "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 181
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='buildTag')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A map of environment variables to be used during local development and deployment."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 246,
+ "module": "_models",
+ "name": "environment_variables",
+ "parsedDocstring": {
+ "text": "A map of environment variables to be used during local development and deployment."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 185
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, str] | None, Field(alias='environmentVariables')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the Dockerfile used for building the Actor on the platform."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 247,
+ "module": "_models",
+ "name": "dockerfile",
+ "parsedDocstring": {
+ "text": "The path to the Dockerfile used for building the Actor on the platform."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 189
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the directory used as the Docker context when building the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 248,
+ "module": "_models",
+ "name": "docker_context_dir",
+ "parsedDocstring": {
+ "text": "The path to the directory used as the Docker context when building the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 193
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='dockerContextDir')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the README file for the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 249,
+ "module": "_models",
+ "name": "readme",
+ "parsedDocstring": {
+ "text": "The path to the README file for the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 197
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 250,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 201
+ }
+ ],
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the CHANGELOG file displayed in the Actor's information tab."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 251,
+ "module": "_models",
+ "name": "changelog",
+ "parsedDocstring": {
+ "text": "The path to the CHANGELOG file displayed in the Actor's information tab."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 205
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 252,
+ "module": "_models",
+ "name": "storages",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 209
+ }
+ ],
+ "type": {
+ "name": "Storages | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Storages",
+ "target": "1255"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 253,
+ "module": "_models",
+ "name": "default_memory_mbytes",
+ "parsedDocstring": {
+ "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 210
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | int | None, Field(alias='defaultMemoryMbytes')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the minimum amount of memory in megabytes required by the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 254,
+ "module": "_models",
+ "name": "min_memory_mbytes",
+ "parsedDocstring": {
+ "text": "Specifies the minimum amount of memory in megabytes required by the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 214
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='minMemoryMbytes', ge=128)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the maximum amount of memory in megabytes required by the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 255,
+ "module": "_models",
+ "name": "max_memory_mbytes",
+ "parsedDocstring": {
+ "text": "Specifies the maximum amount of memory in megabytes required by the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 218
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxMemoryMbytes', ge=128)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies whether Standby mode is enabled for the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 256,
+ "module": "_models",
+ "name": "uses_standby_mode",
+ "parsedDocstring": {
+ "text": "Specifies whether Standby mode is enabled for the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 222
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='usesStandbyMode')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 242,
+ 245,
+ 251,
+ 253,
+ 248,
+ 247,
+ 246,
+ 250,
+ 255,
+ 254,
+ 241,
+ 243,
+ 249,
+ 252,
+ 256,
+ 244
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 240,
+ "module": "_models",
+ "name": "ActorDefinition",
+ "parsedDocstring": {
+ "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 162
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 258,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 232
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 259,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 236
+ }
+ ],
+ "type": {
+ "name": "Actor",
+ "type": "reference",
+ "target": "199"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing Actor data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 259,
+ 258
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 257,
+ "module": "_models",
+ "name": "ActorResponse",
+ "parsedDocstring": {
+ "text": "Response containing Actor data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 229
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 261,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 241
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 262,
+ "module": "_models",
+ "name": "error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 245
+ }
+ ],
+ "type": {
+ "name": "RunFailedErrorDetail | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunFailedErrorDetail",
+ "target": "1069"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 262,
+ 261
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 260,
+ "module": "_models",
+ "name": "ActorRunFailedError",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 240
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 264,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 250
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 265,
+ "module": "_models",
+ "name": "error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 254
+ }
+ ],
+ "type": {
+ "name": "RunTimeoutExceededErrorDetail | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunTimeoutExceededErrorDetail",
+ "target": "1126"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 265,
+ 264
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 263,
+ "module": "_models",
+ "name": "ActorRunTimeoutExceededError",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 249
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 267,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 259
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 268,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 263
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 269,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 264
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 270,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 265
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 271,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 266
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 272,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 267
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 273,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 268
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Hello World Example'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 274,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 269
+ }
+ ],
+ "type": {
+ "name": "ActorStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStats",
+ "target": "285"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 269,
+ 268,
+ 267,
+ 270,
+ 271,
+ 274,
+ 273,
+ 272
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 266,
+ "module": "_models",
+ "name": "ActorShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 258
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 276,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 274
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 277,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 278
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isEnabled')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 278,
+ "module": "_models",
+ "name": "desired_requests_per_actor_run",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 279
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='desiredRequestsPerActorRun')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 279,
+ "module": "_models",
+ "name": "max_requests_per_actor_run",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 280
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxRequestsPerActorRun')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 280,
+ "module": "_models",
+ "name": "idle_timeout_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 281
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='idleTimeoutSecs')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 281,
+ "module": "_models",
+ "name": "build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 282
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 282,
+ "module": "_models",
+ "name": "memory_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 283
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memoryMbytes')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 283,
+ "module": "_models",
+ "name": "disable_standby_fields_override",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 284
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='disableStandbyFieldsOverride')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 284,
+ "module": "_models",
+ "name": "should_pass_actor_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 285
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='shouldPassActorInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 281,
+ 278,
+ 283,
+ 280,
+ 277,
+ 279,
+ 282,
+ 276,
+ 284
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 275,
+ "module": "_models",
+ "name": "ActorStandby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 273
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 286,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 290
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 287,
+ "module": "_models",
+ "name": "total_builds",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 294
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalBuilds', examples=[9])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 288,
+ "module": "_models",
+ "name": "total_runs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 295
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalRuns', examples=[16])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 289,
+ "module": "_models",
+ "name": "total_users",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 296
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalUsers', examples=[6])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 290,
+ "module": "_models",
+ "name": "total_users7_days",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 297
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalUsers7Days', examples=[2])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 291,
+ "module": "_models",
+ "name": "total_users30_days",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 298
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalUsers30Days', examples=[6])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 292,
+ "module": "_models",
+ "name": "total_users90_days",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 299
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalUsers90Days', examples=[6])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 293,
+ "module": "_models",
+ "name": "total_metamorphs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 300
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalMetamorphs', examples=[2])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 294,
+ "module": "_models",
+ "name": "last_run_started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 301
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AwareDatetime | None, Field(alias='lastRunStartedAt', examples=['2019-07-08T14:01:05.546Z']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 295,
+ "module": "_models",
+ "name": "actor_review_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 304
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='actorReviewCount', examples=[69])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 296,
+ "module": "_models",
+ "name": "actor_review_rating",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 305
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='actorReviewRating', examples=[4.7])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 297,
+ "module": "_models",
+ "name": "bookmark_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 306
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='bookmarkCount', examples=[1269])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Run status counts over the past 30 days."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 298,
+ "module": "_models",
+ "name": "public_actor_run_stats30_days",
+ "parsedDocstring": {
+ "text": "Run status counts over the past 30 days."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 307
+ }
+ ],
+ "type": {
+ "name": "Annotated[ PublicActorRunStats30Days | None, Field(alias='publicActorRunStats30Days') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "PublicActorRunStats30Days",
+ "target": "919"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 295,
+ 296,
+ 297,
+ 294,
+ 286,
+ 298,
+ 287,
+ 293,
+ 288,
+ 289,
+ 291,
+ 290,
+ 292
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 285,
+ "module": "_models",
+ "name": "ActorStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 289
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 300,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 319
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 301,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 323
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing the result of adding a request to the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 301,
+ 300
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 299,
+ "module": "_models",
+ "name": "AddRequestResponse",
+ "parsedDocstring": {
+ "text": "Response containing the result of adding a request to the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 316
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 303,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 330
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 304,
+ "module": "_models",
+ "name": "request_id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 334
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 305,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 338
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 306,
+ "module": "_models",
+ "name": "was_already_present",
+ "parsedDocstring": {
+ "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 342
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether a request with the same unique key has already been processed by the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 307,
+ "module": "_models",
+ "name": "was_already_handled",
+ "parsedDocstring": {
+ "text": "Indicates whether a request with the same unique key has already been processed by the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 346
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Information about a request that was successfully added to a request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 303,
+ 304,
+ 305,
+ 307,
+ 306
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 302,
+ "module": "_models",
+ "name": "AddedRequest",
+ "parsedDocstring": {
+ "text": "Information about a request that was successfully added to a request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 327
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 309,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 356
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 310,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 360
+ }
+ ],
+ "type": {
+ "name": "BatchAddResult",
+ "type": "reference",
+ "target": "311"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing the result of a batch add operation."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 310,
+ 309
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 308,
+ "module": "_models",
+ "name": "BatchAddResponse",
+ "parsedDocstring": {
+ "text": "Response containing the result of a batch add operation."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 353
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 312,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 367
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Requests that were successfully added to the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 313,
+ "module": "_models",
+ "name": "processed_requests",
+ "parsedDocstring": {
+ "text": "Requests that were successfully added to the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 371
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "AddedRequest",
+ "target": "302"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Requests that failed to be added and can be retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 314,
+ "module": "_models",
+ "name": "unprocessed_requests",
+ "parsedDocstring": {
+ "text": "Requests that failed to be added and can be retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 375
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Result of a batch add operation containing successfully processed and failed requests."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 312,
+ 313,
+ 314
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 311,
+ "module": "_models",
+ "name": "BatchAddResult",
+ "parsedDocstring": {
+ "text": "Result of a batch add operation containing successfully processed and failed requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 364
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 316,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 385
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 317,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 389
+ }
+ ],
+ "type": {
+ "name": "BatchDeleteResult",
+ "type": "reference",
+ "target": "318"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing the result of a batch delete operation."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 317,
+ 316
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 315,
+ "module": "_models",
+ "name": "BatchDeleteResponse",
+ "parsedDocstring": {
+ "text": "Response containing the result of a batch delete operation."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 382
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 319,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 396
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Requests that were successfully deleted from the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 320,
+ "module": "_models",
+ "name": "processed_requests",
+ "parsedDocstring": {
+ "text": "Requests that were successfully deleted from the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 400
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "DeletedRequestById",
+ "target": "558"
+ },
+ {
+ "type": "reference",
+ "name": "DeletedRequestByUniqueKey",
+ "target": "562"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Requests that failed to be deleted and can be retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 321,
+ "module": "_models",
+ "name": "unprocessed_requests",
+ "parsedDocstring": {
+ "text": "Requests that failed to be deleted and can be retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 406
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Result of a batch delete operation containing successfully deleted and failed requests."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 319,
+ 320,
+ 321
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 318,
+ "module": "_models",
+ "name": "BatchDeleteResult",
+ "parsedDocstring": {
+ "text": "Result of a batch delete operation containing successfully deleted and failed requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 393
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 323,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 414
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP method of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 324,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": "HTTP method of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 418
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "IP address of the client."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 325,
+ "module": "_models",
+ "name": "client_ip",
+ "parsedDocstring": {
+ "text": "IP address of the client."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 422
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='clientIp', examples=['1.2.3.4'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Two-letter country code resolved from the client IP address."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 326,
+ "module": "_models",
+ "name": "country_code",
+ "parsedDocstring": {
+ "text": "Two-letter country code resolved from the client IP address."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 426
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='countryCode', examples=['US'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Length of the request body in bytes."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 327,
+ "module": "_models",
+ "name": "body_length",
+ "parsedDocstring": {
+ "text": "Length of the request body in bytes."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 430
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Request headers. Omitted when `skipHeaders=true`."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 328,
+ "module": "_models",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "Request headers. Omitted when `skipHeaders=true`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 434
+ }
+ ],
+ "type": {
+ "name": "dict[str, str | list[str]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 329,
+ "module": "_models",
+ "name": "raw_headers",
+ "parsedDocstring": {
+ "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 439
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[str] | None, Field(alias='rawHeaders')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 327,
+ 325,
+ 326,
+ 328,
+ 324,
+ 323,
+ 329
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 322,
+ "module": "_models",
+ "name": "BrowserInfoResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 413
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 331,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 449
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 332,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 453
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 333,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 454
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 334,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 455
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 335,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 456
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 336,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 457
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 337,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 460
+ }
+ ],
+ "type": {
+ "name": "ActorJobStatus",
+ "type": "reference",
+ "target": "1892"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 338,
+ "module": "_models",
+ "name": "meta",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 461
+ }
+ ],
+ "type": {
+ "name": "BuildsMeta",
+ "type": "reference",
+ "target": "382"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 339,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 462
+ }
+ ],
+ "type": {
+ "name": "BuildStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BuildStats",
+ "target": "370"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 340,
+ "module": "_models",
+ "name": "options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 463
+ }
+ ],
+ "type": {
+ "name": "BuildOptions | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BuildOptions",
+ "target": "349"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 341,
+ "module": "_models",
+ "name": "usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 464
+ }
+ ],
+ "type": {
+ "name": "BuildUsage | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BuildUsage",
+ "target": "379"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total cost in USD for this build. Requires authentication token to access."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 342,
+ "module": "_models",
+ "name": "usage_total_usd",
+ "parsedDocstring": {
+ "text": "Total cost in USD for this build. Requires authentication token to access."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 465
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.02])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 343,
+ "module": "_models",
+ "name": "usage_usd",
+ "parsedDocstring": {
+ "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 469
+ }
+ ],
+ "type": {
+ "name": "Annotated[BuildUsage | None, Field(alias='usageUsd')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BuildUsage",
+ "target": "379"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 344,
+ "module": "_models",
+ "name": "input_schema",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 473
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='inputSchema', deprecated=True, examples=['{\\\\n \"title\": \"Schema for ... }']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 345,
+ "module": "_models",
+ "name": "readme",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 476
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(deprecated=True, examples=['",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 346,
+ "module": "_models",
+ "name": "build_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 477
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Snapshot of the Actor version that this build was created from."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 347,
+ "module": "_models",
+ "name": "act_version",
+ "parsedDocstring": {
+ "text": "Snapshot of the Actor version that this build was created from."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 485
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActVersion | None, Field(alias='actVersion', title='BuildActVersion')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActVersion",
+ "target": "192"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 348,
+ "module": "_models",
+ "name": "actor_definition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 489
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorDefinition | None, Field(alias='actorDefinition')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorDefinition",
+ "target": "240"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 333,
+ 347,
+ 348,
+ 346,
+ 336,
+ 332,
+ 344,
+ 338,
+ 331,
+ 340,
+ 345,
+ 335,
+ 339,
+ 337,
+ 341,
+ 342,
+ 343,
+ 334
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 330,
+ "module": "_models",
+ "name": "Build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 448
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 350,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 494
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 351,
+ "module": "_models",
+ "name": "use_cache",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 498
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='useCache', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 352,
+ "module": "_models",
+ "name": "beta_packages",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 499
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='betaPackages', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 353,
+ "module": "_models",
+ "name": "memory_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 500
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 354,
+ "module": "_models",
+ "name": "disk_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 501
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='diskMbytes', examples=[2048])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 352,
+ 354,
+ 353,
+ 350,
+ 351
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 349,
+ "module": "_models",
+ "name": "BuildOptions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 493
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 356,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 508
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 357,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 512
+ }
+ ],
+ "type": {
+ "name": "Build",
+ "type": "reference",
+ "target": "330"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing Actor build data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 357,
+ 356
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 355,
+ "module": "_models",
+ "name": "BuildResponse",
+ "parsedDocstring": {
+ "text": "Response containing Actor build data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 505
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 359,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 517
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 360,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 521
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 361,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 522
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId', examples=['janedoe~my-actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 362,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 523
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='userId', examples=['klmdEpoiojmdEMlk3'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 363,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 524
+ }
+ ],
+ "type": {
+ "name": "ActorJobStatus",
+ "type": "reference",
+ "target": "1892"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 364,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 525
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 365,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 526
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 366,
+ "module": "_models",
+ "name": "usage_total_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 529
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 367,
+ "module": "_models",
+ "name": "build_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 530
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 368,
+ "module": "_models",
+ "name": "build_number_int",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 538
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='buildNumberInt', examples=[10000])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 369,
+ "module": "_models",
+ "name": "meta",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 539
+ }
+ ],
+ "type": {
+ "name": "BuildsMeta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BuildsMeta",
+ "target": "382"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 361,
+ 367,
+ 368,
+ 365,
+ 360,
+ 369,
+ 359,
+ 364,
+ 363,
+ 366,
+ 362
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 358,
+ "module": "_models",
+ "name": "BuildShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 516
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 371,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 544
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 372,
+ "module": "_models",
+ "name": "duration_millis",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 548
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='durationMillis', examples=[1000])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 373,
+ "module": "_models",
+ "name": "run_time_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 549
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[45.718])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 374,
+ "module": "_models",
+ "name": "compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 550
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 375,
+ "module": "_models",
+ "name": "image_size_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 551
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='imageSizeBytes', examples=[975770223])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 374,
+ 372,
+ 375,
+ 371,
+ 373
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 370,
+ "module": "_models",
+ "name": "BuildStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 543
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 377,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 556
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 378,
+ "module": "_models",
+ "name": "build_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 560
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 378,
+ 377
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 376,
+ "module": "_models",
+ "name": "BuildTag",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 555
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 380,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 565
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 381,
+ "module": "_models",
+ "name": "actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 569
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.08])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 381,
+ 380
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 379,
+ "module": "_models",
+ "name": "BuildUsage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 564
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 383,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 574
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 384,
+ "module": "_models",
+ "name": "origin",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 578
+ }
+ ],
+ "type": {
+ "name": "RunOrigin",
+ "type": "reference",
+ "target": "1897"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "IP address of the client that started the build."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 385,
+ "module": "_models",
+ "name": "client_ip",
+ "parsedDocstring": {
+ "text": "IP address of the client that started the build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 579
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='clientIp', examples=['172.234.12.34'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "User agent of the client that started the build."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 386,
+ "module": "_models",
+ "name": "user_agent",
+ "parsedDocstring": {
+ "text": "User agent of the client that started the build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 583
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='userAgent', examples=['Mozilla/5.0 (iPad)'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 385,
+ 383,
+ 384,
+ 386
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 382,
+ "module": "_models",
+ "name": "BuildsMeta",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 573
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 388,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 591
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 389,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 595
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='startedAt', examples=['2019-12-12T07:34:14.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 390,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 596
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T07:34:14.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 391,
+ "module": "_models",
+ "name": "error_message",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 599
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='errorMessage', examples=['Cannot send request'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 392,
+ "module": "_models",
+ "name": "response_status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 600
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='responseStatus', examples=[200])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 393,
+ "module": "_models",
+ "name": "response_body",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 601
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='responseBody', examples=['{\"foo\": \"bar\"}'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 391,
+ 390,
+ 388,
+ 393,
+ 392,
+ 389
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 387,
+ "module": "_models",
+ "name": "Call",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 590
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 395,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 606
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 396,
+ "module": "_models",
+ "name": "event_name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 610
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 397,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 611
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 397,
+ 396,
+ 395
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 394,
+ "module": "_models",
+ "name": "ChargeRunRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 605
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 399,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 616
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 400,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 620
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When this pricing info record has been created"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 401,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "When this pricing info record has been created"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 624
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Since when is this pricing info record effective for a given Actor"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 402,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Since when is this pricing info record effective for a given Actor"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 403,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 632
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 404,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 405,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 634
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 406,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 635
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 407,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 638
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 400,
+ 401,
+ 407,
+ 406,
+ 399,
+ 404,
+ 403,
+ 405,
+ 402
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 398,
+ "module": "_models",
+ "name": "CommonActorPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 615
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "target": "622",
+ "type": "reference"
+ },
+ {
+ "name": "FreeActorPricingInfo",
+ "target": "627",
+ "type": "reference"
+ },
+ {
+ "name": "PayPerEventActorPricingInfo",
+ "target": "848",
+ "type": "reference"
+ },
+ {
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "target": "880",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 409,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 645
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 410,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 649
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['MyActor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 411,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 650
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 412,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 651
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 413,
+ "module": "_models",
+ "name": "is_public",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 652
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 414,
+ "module": "_models",
+ "name": "seo_title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 653
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 415,
+ "module": "_models",
+ "name": "seo_description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 654
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 416,
+ "module": "_models",
+ "name": "restart_on_error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 655
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 417,
+ "module": "_models",
+ "name": "versions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 656
+ }
+ ],
+ "type": {
+ "name": "list[Version] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 418,
+ "module": "_models",
+ "name": "pricing_infos",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 657
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "PayPerEventActorPricingInfo",
+ "target": "848"
+ },
+ {
+ "type": "reference",
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "target": "880"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "target": "622"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FreeActorPricingInfo",
+ "target": "627"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 419,
+ "module": "_models",
+ "name": "categories",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 670
+ }
+ ],
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 420,
+ "module": "_models",
+ "name": "default_run_options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 671
+ }
+ ],
+ "type": {
+ "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "DefaultRunOptions",
+ "target": "550"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 421,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 672
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 422,
+ "module": "_models",
+ "name": "example_run_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 673
+ }
+ ],
+ "type": {
+ "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ExampleRunInput",
+ "target": "613"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 423,
+ "module": "_models",
+ "name": "is_deprecated",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 674
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isDeprecated')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 421,
+ 419,
+ 420,
+ 411,
+ 422,
+ 423,
+ 413,
+ 409,
+ 410,
+ 418,
+ 416,
+ 415,
+ 414,
+ 412,
+ 417
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 408,
+ "module": "_models",
+ "name": "CreateActorRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 644
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 425,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 679
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 426,
+ "module": "_models",
+ "name": "version_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 683
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='versionNumber', examples=['0.0'], pattern='^([0-9]|[1-9][0-9])\\\\.([0-9]|[1-9][0-9])$') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 427,
+ "module": "_models",
+ "name": "source_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 686
+ }
+ ],
+ "type": {
+ "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "VersionSourceType",
+ "target": "1900"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 428,
+ "module": "_models",
+ "name": "env_vars",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 687
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[EnvVarRequest] | None, Field(alias='envVars')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "EnvVarRequest",
+ "target": "597"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 429,
+ "module": "_models",
+ "name": "apply_env_vars_to_build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 688
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 430,
+ "module": "_models",
+ "name": "build_tag",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 689
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 431,
+ "module": "_models",
+ "name": "source_files",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 690
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "SourceCodeFile",
+ "target": "1241"
+ },
+ {
+ "type": "reference",
+ "name": "SourceCodeFolder",
+ "target": "1246"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the Git repository when sourceType is GIT_REPO."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 432,
+ "module": "_models",
+ "name": "git_repo_url",
+ "parsedDocstring": {
+ "text": "URL of the Git repository when sourceType is GIT_REPO."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 693
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='gitRepoUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the tarball when sourceType is TARBALL."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 433,
+ "module": "_models",
+ "name": "tarball_url",
+ "parsedDocstring": {
+ "text": "URL of the tarball when sourceType is TARBALL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 697
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='tarballUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 434,
+ "module": "_models",
+ "name": "github_gist_url",
+ "parsedDocstring": {
+ "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 701
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 429,
+ 430,
+ 428,
+ 432,
+ 434,
+ 425,
+ 431,
+ 427,
+ 433,
+ 426
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 424,
+ "module": "_models",
+ "name": "CreateOrUpdateVersionRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 678
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 436,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 709
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 437,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 713
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 438,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 714
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['my-task'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 439,
+ "module": "_models",
+ "name": "options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 715
+ }
+ ],
+ "type": {
+ "name": "TaskOptions | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskOptions",
+ "target": "1303"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 440,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 716
+ }
+ ],
+ "type": {
+ "name": "TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 441,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 717
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 442,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 718
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 437,
+ 442,
+ 440,
+ 436,
+ 438,
+ 439,
+ 441
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 435,
+ "module": "_models",
+ "name": "CreateTaskRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 708
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 444,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 723
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 445,
+ "module": "_models",
+ "name": "monthly_usage_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 727
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 446,
+ "module": "_models",
+ "name": "monthly_actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 728
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 447,
+ "module": "_models",
+ "name": "monthly_external_data_transfer_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 729
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 448,
+ "module": "_models",
+ "name": "monthly_proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 732
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 449,
+ "module": "_models",
+ "name": "monthly_residential_proxy_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 733
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 450,
+ "module": "_models",
+ "name": "actor_memory_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 734
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 451,
+ "module": "_models",
+ "name": "actor_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 735
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 452,
+ "module": "_models",
+ "name": "actor_task_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 736
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 453,
+ "module": "_models",
+ "name": "active_actor_job_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 737
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 454,
+ "module": "_models",
+ "name": "team_account_seat_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 738
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 455,
+ "module": "_models",
+ "name": "schedule_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 739
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='scheduleCount', examples=[77])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 453,
+ 451,
+ 450,
+ 452,
+ 444,
+ 446,
+ 447,
+ 448,
+ 449,
+ 445,
+ 455,
+ 454
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 443,
+ "module": "_models",
+ "name": "Current",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 722
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 457,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 744
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 458,
+ "module": "_models",
+ "name": "pricing_model",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 748
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 459,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 749
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='apifyMarginPercentage', examples=[0.2])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 460,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 750
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='createdAt', examples=['2023-01-01T00:00:00.000Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 461,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 751
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='startedAt', examples=['2023-01-01T00:00:00.000Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 462,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 752
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 463,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 755
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt', examples=[None]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 464,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 758
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed', examples=[False]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 465,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 761
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange', examples=[False]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 466,
+ "module": "_models",
+ "name": "is_ppe_platform_usage_paid_by_user",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 764
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPPEPlatformUsagePaidByUser', examples=[False]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 467,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 767
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 468,
+ "module": "_models",
+ "name": "trial_minutes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 768
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='trialMinutes', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 469,
+ "module": "_models",
+ "name": "unit_name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 769
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='unitName', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 470,
+ "module": "_models",
+ "name": "price_per_unit_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 770
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='pricePerUnitUsd', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 471,
+ "module": "_models",
+ "name": "minimal_max_total_charge_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 771
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd', examples=[0.5])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Per-event pricing configuration for pay-per-event Actors."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 472,
+ "module": "_models",
+ "name": "pricing_per_event",
+ "parsedDocstring": {
+ "text": "Per-event pricing configuration for pay-per-event Actors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 774
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(alias='pricingPerEvent')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 459,
+ 460,
+ 465,
+ 466,
+ 464,
+ 471,
+ 457,
+ 462,
+ 463,
+ 470,
+ 458,
+ 472,
+ 467,
+ 461,
+ 468,
+ 469
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 456,
+ "module": "_models",
+ "name": "CurrentPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 743
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 474,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 782
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 475,
+ "module": "_models",
+ "name": "date",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 786
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 476,
+ "module": "_models",
+ "name": "service_usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 787
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "UsageItem",
+ "target": "1395"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 477,
+ "module": "_models",
+ "name": "total_usage_credits_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 788
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 475,
+ 474,
+ 476,
+ 477
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 473,
+ "module": "_models",
+ "name": "DailyServiceUsages",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 781
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 479,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 793
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 480,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 797
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 481,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 798
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 482,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 799
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 483,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 800
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 484,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 801
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 485,
+ "module": "_models",
+ "name": "accessed_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 802
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 486,
+ "module": "_models",
+ "name": "item_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 803
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 487,
+ "module": "_models",
+ "name": "clean_item_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 804
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 488,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 805
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 489,
+ "module": "_models",
+ "name": "act_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 806
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actRunId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 490,
+ "module": "_models",
+ "name": "fields",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 807
+ }
+ ],
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 491,
+ "module": "_models",
+ "name": "schema_",
+ "parsedDocstring": {
+ "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 808
+ }
+ ],
+ "type": {
+ "name": "Annotated[ dict[str, Any] | None, Field( alias='schema', examples=[ { 'actorSpecification': 1, 'title': 'My dataset', 'views': { 'overview': { 'title': 'Overview', 'transformation': {'fields': ['linkUrl']}, 'display': { 'component': 'table', 'properties': {'linkUrl': {'label': 'Link URL', 'format': 'link'}}, }, } }, } ], ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 492,
+ "module": "_models",
+ "name": "console_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 833
+ }
+ ],
+ "type": {
+ "name": "AnyUrl",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A public link to access the dataset items directly."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 493,
+ "module": "_models",
+ "name": "items_public_url",
+ "parsedDocstring": {
+ "text": "A public link to access the dataset items directly."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 836
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field( alias='itemsPublicUrl', examples=['https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'], ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 494,
+ "module": "_models",
+ "name": "url_signing_secret_key",
+ "parsedDocstring": {
+ "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 846
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 495,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 850
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 496,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 851
+ }
+ ],
+ "type": {
+ "name": "DatasetStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "DatasetStats",
+ "target": "533"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 485,
+ 488,
+ 489,
+ 487,
+ 492,
+ 483,
+ 490,
+ 495,
+ 480,
+ 486,
+ 493,
+ 479,
+ 484,
+ 481,
+ 491,
+ 496,
+ 494,
+ 482
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 478,
+ "module": "_models",
+ "name": "Dataset",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 792
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 498,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 856
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 499,
+ "module": "_models",
+ "name": "min",
+ "parsedDocstring": {
+ "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 860
+ }
+ ],
+ "type": {
+ "name": "float | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 500,
+ "module": "_models",
+ "name": "max",
+ "parsedDocstring": {
+ "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 864
+ }
+ ],
+ "type": {
+ "name": "float | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many items in the dataset have a null value for this field."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 501,
+ "module": "_models",
+ "name": "null_count",
+ "parsedDocstring": {
+ "text": "How many items in the dataset have a null value for this field."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 868
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='nullCount')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 502,
+ "module": "_models",
+ "name": "empty_count",
+ "parsedDocstring": {
+ "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 872
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='emptyCount')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 502,
+ 500,
+ 499,
+ 498,
+ 501
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 497,
+ "module": "_models",
+ "name": "DatasetFieldStatistics",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 855
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 504,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 880
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 505,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 884
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 506,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 885
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 507,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 886
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 508,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 887
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 509,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 888
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 510,
+ "module": "_models",
+ "name": "accessed_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 889
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 511,
+ "module": "_models",
+ "name": "item_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 890
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 512,
+ "module": "_models",
+ "name": "clean_item_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 891
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 513,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 892
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId', examples=['zdc3Pyhyz3m8vjDeM'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 514,
+ "module": "_models",
+ "name": "act_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 893
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actRunId', examples=['HG7ML7M8z78YcAPEB'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 515,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 894
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My Dataset'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 516,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 895
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['janedoe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 517,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 896
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 518,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 897
+ }
+ ],
+ "type": {
+ "name": "DatasetStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "DatasetStats",
+ "target": "533"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 510,
+ 513,
+ 514,
+ 512,
+ 508,
+ 517,
+ 505,
+ 511,
+ 504,
+ 509,
+ 506,
+ 518,
+ 515,
+ 507,
+ 516
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 503,
+ "module": "_models",
+ "name": "DatasetListItem",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 879
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 520,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 904
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 521,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 908
+ }
+ ],
+ "type": {
+ "name": "Dataset",
+ "type": "reference",
+ "target": "478"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing dataset metadata."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 521,
+ 520
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 519,
+ "module": "_models",
+ "name": "DatasetResponse",
+ "parsedDocstring": {
+ "text": "Response containing dataset metadata."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 901
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 523,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 913
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The type of the error."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 524,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": "The type of the error."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 917
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['schema-validation-error'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-readable message describing the error."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 525,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": "A human-readable message describing the error."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 921
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Schema validation failed'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 526,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 925
+ }
+ ],
+ "type": {
+ "name": "SchemaValidationErrorData | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "SchemaValidationErrorData",
+ "target": "1238"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 526,
+ 525,
+ 523,
+ 524
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 522,
+ "module": "_models",
+ "name": "DatasetSchemaValidationError",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 912
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 528,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 930
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.
See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 529,
+ "module": "_models",
+ "name": "field_statistics",
+ "parsedDocstring": {
+ "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.
See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 934
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(alias='fieldStatistics')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 529,
+ 528
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 527,
+ "module": "_models",
+ "name": "DatasetStatistics",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 929
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 531,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 942
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 532,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 946
+ }
+ ],
+ "type": {
+ "name": "DatasetStatistics",
+ "type": "reference",
+ "target": "527"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 532,
+ 531
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 530,
+ "module": "_models",
+ "name": "DatasetStatisticsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 941
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 534,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 951
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 535,
+ "module": "_models",
+ "name": "read_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 955
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='readCount', examples=[22])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 536,
+ "module": "_models",
+ "name": "write_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 956
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='writeCount', examples=[3])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total storage size in bytes. Only returned by the single-dataset endpoint."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 537,
+ "module": "_models",
+ "name": "storage_bytes",
+ "parsedDocstring": {
+ "text": "Total storage size in bytes. Only returned by the single-dataset endpoint."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 957
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='storageBytes', examples=[783])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Uncompressed size in bytes. Only returned by the dataset list endpoint."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 538,
+ "module": "_models",
+ "name": "inflated_bytes",
+ "parsedDocstring": {
+ "text": "Uncompressed size in bytes. Only returned by the dataset list endpoint."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 961
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='inflatedBytes', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 538,
+ 534,
+ 535,
+ 537,
+ 536
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 533,
+ "module": "_models",
+ "name": "DatasetStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 950
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 540,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 971
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default dataset for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 541,
+ "module": "_models",
+ "name": "default",
+ "parsedDocstring": {
+ "text": "ID of the default dataset for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 975
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['wmKPijuyDnPZAPRMk'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased dataset IDs for this run."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 541,
+ 540
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 539,
+ "module": "_models",
+ "name": "Datasets",
+ "parsedDocstring": {
+ "text": "Aliased dataset IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 968
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 543,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 983
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The original object that was encoded."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 544,
+ "module": "_models",
+ "name": "decoded",
+ "parsedDocstring": {
+ "text": "The original object that was encoded."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 987
+ }
+ ],
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 545,
+ "module": "_models",
+ "name": "encoded_by_user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 991
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='encodedByUserId', examples=['wRwJZtadYvn4mBZmm'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 546,
+ "module": "_models",
+ "name": "is_verified_user",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 992
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 544,
+ 545,
+ 546,
+ 543
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 542,
+ "module": "_models",
+ "name": "DecodeAndVerifyData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 982
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 548,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 997
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 549,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1001
+ }
+ ],
+ "type": {
+ "name": "DecodeAndVerifyData",
+ "type": "reference",
+ "target": "542"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 549,
+ 548
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 547,
+ "module": "_models",
+ "name": "DecodeAndVerifyResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 996
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 551,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1006
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 552,
+ "module": "_models",
+ "name": "build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1010
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['latest'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 553,
+ "module": "_models",
+ "name": "timeout_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1011
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[3600])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 554,
+ "module": "_models",
+ "name": "memory_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1012
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[2048])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 555,
+ "module": "_models",
+ "name": "restart_on_error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1013
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 556,
+ "module": "_models",
+ "name": "max_items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1014
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxItems')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 557,
+ "module": "_models",
+ "name": "force_permission_level",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1015
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorPermissionLevel | None, Field(alias='forcePermissionLevel')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 552,
+ 557,
+ 556,
+ 554,
+ 551,
+ 555,
+ 553
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 550,
+ "module": "_models",
+ "name": "DefaultRunOptions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1005
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 559,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1022
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 560,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1026
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 561,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1032
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Confirmation of a request that was successfully deleted, identified by its ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 561,
+ 559,
+ 560
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 558,
+ "module": "_models",
+ "name": "DeletedRequestById",
+ "parsedDocstring": {
+ "text": "Confirmation of a request that was successfully deleted, identified by its ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1019
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 563,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1042
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 564,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1046
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 565,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1050
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Confirmation of a request that was successfully deleted, identified by its unique key."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 565,
+ 563,
+ 564
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 562,
+ "module": "_models",
+ "name": "DeletedRequestByUniqueKey",
+ "parsedDocstring": {
+ "text": "Confirmation of a request that was successfully deleted, identified by its unique key."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1039
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 567,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1058
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 568,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1062
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 569,
+ "module": "_models",
+ "name": "disabled_reason",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1063
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field( alias='disabledReason', examples=[ 'The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com' ], ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 570,
+ "module": "_models",
+ "name": "disabled_reason_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1072
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='disabledReasonType', examples=['DISABLED'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 571,
+ "module": "_models",
+ "name": "is_trial",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1073
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 572,
+ "module": "_models",
+ "name": "trial_expiration_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1074
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AwareDatetime | None, Field(alias='trialExpirationAt', examples=['2025-01-01T14:00:00.000Z']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 569,
+ 570,
+ 568,
+ 571,
+ 567,
+ 572
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 566,
+ "module": "_models",
+ "name": "EffectivePlatformFeature",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1057
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 574,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1081
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 575,
+ "module": "_models",
+ "name": "actors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1085
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 576,
+ "module": "_models",
+ "name": "storage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1086
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 577,
+ "module": "_models",
+ "name": "scheduler",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1087
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 578,
+ "module": "_models",
+ "name": "proxy",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1088
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 579,
+ "module": "_models",
+ "name": "proxy_external_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1089
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 580,
+ "module": "_models",
+ "name": "proxy_residential",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1090
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 581,
+ "module": "_models",
+ "name": "proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1091
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 582,
+ "module": "_models",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1092
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 583,
+ "module": "_models",
+ "name": "actors_public_all",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1093
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 584,
+ "module": "_models",
+ "name": "actors_public_developer",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1094
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeature",
+ "type": "reference",
+ "target": "566"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 575,
+ 583,
+ 584,
+ 574,
+ 578,
+ 579,
+ 580,
+ 581,
+ 577,
+ 576,
+ 582
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 573,
+ "module": "_models",
+ "name": "EffectivePlatformFeatures",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1080
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 586,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1099
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 587,
+ "module": "_models",
+ "name": "encoded",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1103
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 587,
+ 586
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 585,
+ "module": "_models",
+ "name": "EncodeAndSignData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1098
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "DecodeAndVerifyRequest",
+ "target": "588",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4248,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1099
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "EncodeAndSignData.model_config",
+ "target": 586,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4249,
+ "module": "_models",
+ "name": "encoded",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1103
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "EncodeAndSignData.encoded",
+ "target": 587,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4249,
+ 4248
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 588,
+ "module": "_models",
+ "name": "DecodeAndVerifyRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1107
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "EncodeAndSignData",
+ "target": "585",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 590,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1113
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 591,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1117
+ }
+ ],
+ "type": {
+ "name": "EncodeAndSignData",
+ "type": "reference",
+ "target": "585"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 591,
+ 590
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 589,
+ "module": "_models",
+ "name": "EncodeAndSignResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1112
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 593,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1122
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 594,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1126
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 595,
+ "module": "_models",
+ "name": "value",
+ "parsedDocstring": {
+ "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1127
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['my-value'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 596,
+ "module": "_models",
+ "name": "is_secret",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1131
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 596,
+ 593,
+ 594,
+ 595
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 592,
+ "module": "_models",
+ "name": "EnvVar",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1121
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "EnvVarRequest",
+ "target": "597",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 598,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1136
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "EnvVar.model_config",
+ "target": 593,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4245,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1126
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "EnvVar.name",
+ "target": 594,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4246,
+ "module": "_models",
+ "name": "value",
+ "parsedDocstring": {
+ "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1127
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['my-value'])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "EnvVar.value",
+ "target": 595,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4247,
+ "module": "_models",
+ "name": "is_secret",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1131
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "EnvVar.is_secret",
+ "target": 596,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4247,
+ 598,
+ 4245,
+ 4246
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 597,
+ "module": "_models",
+ "name": "EnvVarRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1135
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "EnvVar",
+ "target": "592",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 600,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1144
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 601,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1148
+ }
+ ],
+ "type": {
+ "name": "EnvVar",
+ "type": "reference",
+ "target": "592"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 601,
+ 600
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 599,
+ "module": "_models",
+ "name": "EnvVarResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1143
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 603,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1153
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 604,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1157
+ }
+ ],
+ "type": {
+ "name": "ErrorType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ErrorType",
+ "target": "1894"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Human-readable error message describing what went wrong."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 605,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": "Human-readable error message describing what went wrong."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1158
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 605,
+ 603,
+ 604
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 602,
+ "module": "_models",
+ "name": "ErrorDetail",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1152
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "RunFailedErrorDetail",
+ "target": "1069",
+ "type": "reference"
+ },
+ {
+ "name": "RunTimeoutExceededErrorDetail",
+ "target": "1126",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 607,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1166
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 608,
+ "module": "_models",
+ "name": "error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1170
+ }
+ ],
+ "type": {
+ "name": "ErrorDetail",
+ "type": "reference",
+ "target": "602"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 608,
+ 607
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 606,
+ "module": "_models",
+ "name": "ErrorResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1165
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 610,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1175
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 611,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1179
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 612,
+ "module": "_models",
+ "name": "actor_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1180
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 611,
+ 612,
+ 610
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 609,
+ "module": "_models",
+ "name": "EventData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1174
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 614,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1185
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 615,
+ "module": "_models",
+ "name": "body",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1189
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['{ \"helloWorld\": 123 }'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 616,
+ "module": "_models",
+ "name": "content_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1190
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 615,
+ 616,
+ 614
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 613,
+ "module": "_models",
+ "name": "ExampleRunInput",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1184
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 618,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1195
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 619,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1199
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatchStatus",
+ "type": "reference",
+ "target": "1901"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 620,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1200
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 621,
+ "module": "_models",
+ "name": "removed_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1203
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='removedAt', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 620,
+ 618,
+ 621,
+ 619
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 617,
+ "module": "_models",
+ "name": "ExampleWebhookDispatch",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1194
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 623,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1208
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "CommonActorPricingInfo.model_config",
+ "target": 399,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 624,
+ "module": "_models",
+ "name": "pricing_model",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1212
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "FLAT_PRICE_PER_MONTH"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "For how long this Actor can be used for free in trial period"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 625,
+ "module": "_models",
+ "name": "trial_minutes",
+ "parsedDocstring": {
+ "text": "For how long this Actor can be used for free in trial period"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1213
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Monthly flat price in USD"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 626,
+ "module": "_models",
+ "name": "price_per_unit_usd",
+ "parsedDocstring": {
+ "text": "Monthly flat price in USD"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1217
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4213,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 620
+ }
+ ],
+ "type": {
+ "name": "Annotated[float, Field(alias='apifyMarginPercentage')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.apify_margin_percentage",
+ "target": 400,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When this pricing info record has been created"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4214,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "When this pricing info record has been created"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 624
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='createdAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.created_at",
+ "target": 401,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Since when is this pricing info record effective for a given Actor"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4215,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Since when is this pricing info record effective for a given Actor"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='startedAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.started_at",
+ "target": 402,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4216,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 632
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_future_change_at",
+ "target": 403,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4217,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_change_at",
+ "target": 404,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4218,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 634
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.reason_for_change",
+ "target": 405,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4219,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 635
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.is_price_change_notification_suppressed",
+ "target": 406,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4220,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 638
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.force_contains_significant_price_change",
+ "target": 407,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4213,
+ 4214,
+ 4220,
+ 4219,
+ 623,
+ 4217,
+ 4216,
+ 626,
+ 624,
+ 4218,
+ 4215,
+ 625
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 622,
+ "module": "_models",
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1207
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "CommonActorPricingInfo",
+ "target": "398",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 628,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1225
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "CommonActorPricingInfo.model_config",
+ "target": 399,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 629,
+ "module": "_models",
+ "name": "pricing_model",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1229
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "FREE"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4221,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 620
+ }
+ ],
+ "type": {
+ "name": "Annotated[float, Field(alias='apifyMarginPercentage')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.apify_margin_percentage",
+ "target": 400,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When this pricing info record has been created"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4222,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "When this pricing info record has been created"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 624
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='createdAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.created_at",
+ "target": 401,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Since when is this pricing info record effective for a given Actor"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4223,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Since when is this pricing info record effective for a given Actor"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='startedAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.started_at",
+ "target": 402,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4224,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 632
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_future_change_at",
+ "target": 403,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4225,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_change_at",
+ "target": 404,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4226,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 634
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.reason_for_change",
+ "target": 405,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4227,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 635
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.is_price_change_notification_suppressed",
+ "target": 406,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4228,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 638
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.force_contains_significant_price_change",
+ "target": 407,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4221,
+ 4222,
+ 4228,
+ 4227,
+ 628,
+ 4225,
+ 4224,
+ 629,
+ 4226,
+ 4223
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 627,
+ "module": "_models",
+ "name": "FreeActorPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1224
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "CommonActorPricingInfo",
+ "target": "398",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 631,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1236
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 632,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1240
+ }
+ ],
+ "type": {
+ "name": "LockedRequestQueueHead",
+ "type": "reference",
+ "target": "777"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing locked requests from the request queue head."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 632,
+ 631
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 630,
+ "module": "_models",
+ "name": "HeadAndLockResponse",
+ "parsedDocstring": {
+ "text": "Response containing locked requests from the request queue head."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1233
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 634,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1247
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 635,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1251
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 636,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1255
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 637,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1259
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 638,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1263
+ }
+ ],
+ "type": {
+ "name": "HttpMethod | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpMethod",
+ "target": "1896"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 639,
+ "module": "_models",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1264
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request from the request queue head without lock information."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 635,
+ 638,
+ 634,
+ 639,
+ 636,
+ 637
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 633,
+ "module": "_models",
+ "name": "HeadRequest",
+ "parsedDocstring": {
+ "text": "A request from the request queue head without lock information."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1244
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 641,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1274
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 642,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1278
+ }
+ ],
+ "type": {
+ "name": "RequestQueueHead",
+ "type": "reference",
+ "target": "990"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing requests from the request queue head without locking."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 642,
+ 641
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 640,
+ "module": "_models",
+ "name": "HeadResponse",
+ "parsedDocstring": {
+ "text": "Response containing requests from the request queue head without locking."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1271
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 644,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1283
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The position of the invalid item in the array."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 645,
+ "module": "_models",
+ "name": "item_position",
+ "parsedDocstring": {
+ "text": "The position of the invalid item in the array."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1287
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='itemPosition', examples=[2])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A complete list of AJV validation error objects for the invalid item."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 646,
+ "module": "_models",
+ "name": "validation_errors",
+ "parsedDocstring": {
+ "text": "A complete list of AJV validation error objects for the invalid item."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1291
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[ValidationError] | None, Field(alias='validationErrors')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ValidationError",
+ "target": "1417"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 645,
+ 644,
+ 646
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 643,
+ "module": "_models",
+ "name": "InvalidItem",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1282
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 648,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1299
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 649,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1303
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 650,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1304
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 651,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1305
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='userId', examples=['BPWDBd7Z9c746JAnF'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 652,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1306
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['janedoe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 653,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1307
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 654,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1308
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 655,
+ "module": "_models",
+ "name": "accessed_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1309
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 656,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1310
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 657,
+ "module": "_models",
+ "name": "act_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1311
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actRunId', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 658,
+ "module": "_models",
+ "name": "console_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1312
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field(alias='consoleUrl', examples=['https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC']), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A public link to access keys of the key-value store directly."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 659,
+ "module": "_models",
+ "name": "keys_public_url",
+ "parsedDocstring": {
+ "text": "A public link to access keys of the key-value store directly."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1316
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field( alias='keysPublicUrl', examples=['https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'], ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A public link to access records of the key-value store directly."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 660,
+ "module": "_models",
+ "name": "records_public_url",
+ "parsedDocstring": {
+ "text": "A public link to access records of the key-value store directly."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1326
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field( alias='recordsPublicUrl', examples=['https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records'] ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional JSON schema describing the keys stored in the key-value store."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 661,
+ "module": "_models",
+ "name": "schema_",
+ "parsedDocstring": {
+ "text": "Optional JSON schema describing the keys stored in the key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1335
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(alias='schema')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 662,
+ "module": "_models",
+ "name": "url_signing_secret_key",
+ "parsedDocstring": {
+ "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1339
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 663,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1343
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 664,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1344
+ }
+ ],
+ "type": {
+ "name": "KeyValueStoreStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreStats",
+ "target": "673"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 655,
+ 656,
+ 657,
+ 658,
+ 653,
+ 663,
+ 649,
+ 659,
+ 648,
+ 654,
+ 650,
+ 660,
+ 661,
+ 664,
+ 662,
+ 651,
+ 652
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 647,
+ "module": "_models",
+ "name": "KeyValueStore",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1298
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 666,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1349
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 667,
+ "module": "_models",
+ "name": "key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1353
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 668,
+ "module": "_models",
+ "name": "size",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1354
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A public link to access this record directly."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 669,
+ "module": "_models",
+ "name": "record_public_url",
+ "parsedDocstring": {
+ "text": "A public link to access this record directly."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1355
+ }
+ ],
+ "type": {
+ "name": "AnyUrl",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 667,
+ 666,
+ 669,
+ 668
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 665,
+ "module": "_models",
+ "name": "KeyValueStoreKey",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1348
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 671,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1371
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 672,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1375
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore",
+ "type": "reference",
+ "target": "647"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing key-value store data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 672,
+ 671
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 670,
+ "module": "_models",
+ "name": "KeyValueStoreResponse",
+ "parsedDocstring": {
+ "text": "Response containing key-value store data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1368
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 674,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1380
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 675,
+ "module": "_models",
+ "name": "read_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1384
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 676,
+ "module": "_models",
+ "name": "write_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1385
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 677,
+ "module": "_models",
+ "name": "delete_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1386
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 678,
+ "module": "_models",
+ "name": "list_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1387
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 679,
+ "module": "_models",
+ "name": "s3_storage_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1388
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='s3StorageBytes', examples=[18])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 680,
+ "module": "_models",
+ "name": "storage_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1389
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='storageBytes', examples=[457225])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 677,
+ 678,
+ 674,
+ 675,
+ 679,
+ 680,
+ 676
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 673,
+ "module": "_models",
+ "name": "KeyValueStoreStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1379
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 682,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1396
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default key-value store for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 683,
+ "module": "_models",
+ "name": "default",
+ "parsedDocstring": {
+ "text": "ID of the default key-value store for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1400
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['eJNzqsbPiopwJcgGQ'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased key-value store IDs for this run."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 683,
+ 682
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 681,
+ "module": "_models",
+ "name": "KeyValueStores",
+ "parsedDocstring": {
+ "text": "Aliased key-value store IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1393
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 685,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1408
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 686,
+ "module": "_models",
+ "name": "max_monthly_usage_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1412
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 687,
+ "module": "_models",
+ "name": "max_monthly_actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1413
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 688,
+ "module": "_models",
+ "name": "max_monthly_external_data_transfer_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1414
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 689,
+ "module": "_models",
+ "name": "max_monthly_proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1417
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 690,
+ "module": "_models",
+ "name": "max_monthly_residential_proxy_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1418
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 691,
+ "module": "_models",
+ "name": "max_actor_memory_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1421
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 692,
+ "module": "_models",
+ "name": "max_actor_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1422
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 693,
+ "module": "_models",
+ "name": "max_actor_task_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1423
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 694,
+ "module": "_models",
+ "name": "max_concurrent_actor_jobs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1424
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 695,
+ "module": "_models",
+ "name": "max_team_account_seat_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1425
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 696,
+ "module": "_models",
+ "name": "data_retention_days",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1426
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 697,
+ "module": "_models",
+ "name": "max_schedule_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1427
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxScheduleCount', examples=[100])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 696,
+ 692,
+ 691,
+ 693,
+ 694,
+ 687,
+ 688,
+ 689,
+ 690,
+ 686,
+ 697,
+ 695,
+ 685
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 684,
+ "module": "_models",
+ "name": "Limits",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1407
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 699,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1432
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 700,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1436
+ }
+ ],
+ "type": {
+ "name": "AccountLimits",
+ "type": "reference",
+ "target": "187"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 700,
+ 699
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 698,
+ "module": "_models",
+ "name": "LimitsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1431
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 702,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1441
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 703,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1445
+ }
+ ],
+ "type": {
+ "name": "ListOfStoreActors",
+ "type": "reference",
+ "target": "836"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 703,
+ 702
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 701,
+ "module": "_models",
+ "name": "ListOfActorsInStoreResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1440
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 705,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1450
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 706,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1454
+ }
+ ],
+ "type": {
+ "name": "ListOfActors",
+ "type": "reference",
+ "target": "812"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 706,
+ 705
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 704,
+ "module": "_models",
+ "name": "ListOfActorsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1449
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 708,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1459
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 709,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1463
+ }
+ ],
+ "type": {
+ "name": "ListOfBuilds",
+ "type": "reference",
+ "target": "815"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 709,
+ 708
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 707,
+ "module": "_models",
+ "name": "ListOfBuildsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1458
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 711,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1468
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 712,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1472
+ }
+ ],
+ "type": {
+ "name": "ListOfDatasets",
+ "type": "reference",
+ "target": "818"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 712,
+ 711
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 710,
+ "module": "_models",
+ "name": "ListOfDatasetsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1467
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 714,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1477
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 715,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1481
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 716,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1482
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 716,
+ 714,
+ 715
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 713,
+ "module": "_models",
+ "name": "ListOfEnvVars",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1476
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 718,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1487
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 719,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1491
+ }
+ ],
+ "type": {
+ "name": "ListOfEnvVars",
+ "type": "reference",
+ "target": "713"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 719,
+ 718
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 717,
+ "module": "_models",
+ "name": "ListOfEnvVarsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1486
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 721,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1496
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 722,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1500
+ }
+ ],
+ "type": {
+ "name": "ListOfKeyValueStores",
+ "type": "reference",
+ "target": "822"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 722,
+ 721
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 720,
+ "module": "_models",
+ "name": "ListOfKeyValueStoresResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1495
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 724,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1505
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 725,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1509
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreKey",
+ "target": "665"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 726,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1510
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 727,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1511
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 728,
+ "module": "_models",
+ "name": "exclusive_start_key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1512
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='exclusiveStartKey', examples=['some-key'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 729,
+ "module": "_models",
+ "name": "is_truncated",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1513
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 730,
+ "module": "_models",
+ "name": "next_exclusive_start_key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1514
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='nextExclusiveStartKey', examples=['third-key'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 726,
+ 728,
+ 729,
+ 725,
+ 727,
+ 724,
+ 730
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 723,
+ "module": "_models",
+ "name": "ListOfKeys",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1504
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 732,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1519
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 733,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1523
+ }
+ ],
+ "type": {
+ "name": "ListOfKeys",
+ "type": "reference",
+ "target": "723"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 733,
+ 732
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 731,
+ "module": "_models",
+ "name": "ListOfKeysResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1518
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 735,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1530
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 736,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1534
+ }
+ ],
+ "type": {
+ "name": "ListOfRequestQueues",
+ "type": "reference",
+ "target": "826"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing a list of request queues."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 736,
+ 735
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 734,
+ "module": "_models",
+ "name": "ListOfRequestQueuesResponse",
+ "parsedDocstring": {
+ "text": "Response containing a list of request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1527
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 738,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1541
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The array of requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 739,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": "The array of requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1545
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of requests returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 740,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of requests returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1549
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the last request from the previous page, used for pagination."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 741,
+ "module": "_models",
+ "name": "exclusive_start_id",
+ "parsedDocstring": {
+ "text": "The ID of the last request from the previous page, used for pagination."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1553
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='exclusiveStartId', deprecated=True, examples=['Ihnsp8YrvJ8102Kj']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A cursor string used for current page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 742,
+ "module": "_models",
+ "name": "cursor",
+ "parsedDocstring": {
+ "text": "A cursor string used for current page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1559
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['eyJyZXF1ZXN0SWQiOiI0SVlLUWFXZ2FKUUlWNlMifQ'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A cursor string to be used to continue pagination."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 743,
+ "module": "_models",
+ "name": "next_cursor",
+ "parsedDocstring": {
+ "text": "A cursor string to be used to continue pagination."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1563
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='nextCursor', examples=['eyJyZXF1ZXN0SWQiOiI5eFNNc1BrN1J6VUxTNXoifQ']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A paginated list of requests from the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 742,
+ 741,
+ 739,
+ 740,
+ 738,
+ 743
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 737,
+ "module": "_models",
+ "name": "ListOfRequests",
+ "parsedDocstring": {
+ "text": "A paginated list of requests from the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1538
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 745,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1575
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 746,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1579
+ }
+ ],
+ "type": {
+ "name": "ListOfRequests",
+ "type": "reference",
+ "target": "737"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing a list of requests from the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 746,
+ 745
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 744,
+ "module": "_models",
+ "name": "ListOfRequestsResponse",
+ "parsedDocstring": {
+ "text": "Response containing a list of requests from the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1572
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 748,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1584
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 749,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1588
+ }
+ ],
+ "type": {
+ "name": "ListOfRuns",
+ "type": "reference",
+ "target": "830"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 749,
+ 748
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 747,
+ "module": "_models",
+ "name": "ListOfRunsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1583
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 751,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1593
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 752,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1597
+ }
+ ],
+ "type": {
+ "name": "ListOfSchedules",
+ "type": "reference",
+ "target": "833"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 752,
+ 751
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 750,
+ "module": "_models",
+ "name": "ListOfSchedulesResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1592
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 754,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1602
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 755,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1606
+ }
+ ],
+ "type": {
+ "name": "ListOfTasks",
+ "type": "reference",
+ "target": "839"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 755,
+ 754
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 753,
+ "module": "_models",
+ "name": "ListOfTasksResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1601
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 757,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1611
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 758,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1615
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 759,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1616
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 759,
+ 757,
+ 758
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 756,
+ "module": "_models",
+ "name": "ListOfVersions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1610
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 761,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1621
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 762,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1625
+ }
+ ],
+ "type": {
+ "name": "ListOfVersions",
+ "type": "reference",
+ "target": "756"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 762,
+ 761
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 760,
+ "module": "_models",
+ "name": "ListOfVersionsResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1620
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 764,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1630
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 765,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1634
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhookDispatches",
+ "type": "reference",
+ "target": "842"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 765,
+ 764
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 763,
+ "module": "_models",
+ "name": "ListOfWebhookDispatchesResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1629
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 767,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1639
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 768,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1643
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhooks",
+ "type": "reference",
+ "target": "845"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 768,
+ 767
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 766,
+ "module": "_models",
+ "name": "ListOfWebhooksResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1638
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 770,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1650
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 771,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1654
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 772,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1658
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 773,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1662
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 774,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1666
+ }
+ ],
+ "type": {
+ "name": "HttpMethod | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpMethod",
+ "target": "1896"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 775,
+ "module": "_models",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1667
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the lock on this request expires."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 776,
+ "module": "_models",
+ "name": "lock_expires_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the lock on this request expires."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1671
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request from the request queue head that has been locked for processing."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 771,
+ 776,
+ 774,
+ 770,
+ 775,
+ 772,
+ 773
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 769,
+ "module": "_models",
+ "name": "LockedHeadRequest",
+ "parsedDocstring": {
+ "text": "A request from the request queue head that has been locked for processing."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1647
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 778,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1681
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of requests returned."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 779,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of requests returned."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1685
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 780,
+ "module": "_models",
+ "name": "queue_modified_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1689
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 781,
+ "module": "_models",
+ "name": "queue_has_locked_requests",
+ "parsedDocstring": {
+ "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1693
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='queueHasLockedRequests', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The client key used for locking the requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 782,
+ "module": "_models",
+ "name": "client_key",
+ "parsedDocstring": {
+ "text": "The client key used for locking the requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1697
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='clientKey', examples=['client-one'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 783,
+ "module": "_models",
+ "name": "had_multiple_clients",
+ "parsedDocstring": {
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1701
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of seconds the locks will be held."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 784,
+ "module": "_models",
+ "name": "lock_secs",
+ "parsedDocstring": {
+ "text": "The number of seconds the locks will be held."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1705
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The array of locked requests from the request queue head."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 785,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": "The array of locked requests from the request queue head."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1709
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "LockedHeadRequest",
+ "target": "769"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A batch of locked requests from the request queue head."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 782,
+ 783,
+ 785,
+ 779,
+ 784,
+ 778,
+ 781,
+ 780
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 777,
+ "module": "_models",
+ "name": "LockedRequestQueueHead",
+ "parsedDocstring": {
+ "text": "A batch of locked requests from the request queue head."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1678
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 787,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1719
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Time when the metamorph occurred."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 788,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "Time when the metamorph occurred."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1723
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the Actor that the run was metamorphed to."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 789,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": "ID of the Actor that the run was metamorphed to."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1727
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the build used for the metamorphed Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 790,
+ "module": "_models",
+ "name": "build_id",
+ "parsedDocstring": {
+ "text": "ID of the build used for the metamorphed Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1731
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the input record in the key-value store."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 791,
+ "module": "_models",
+ "name": "input_key",
+ "parsedDocstring": {
+ "text": "Key of the input record in the key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1735
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='inputKey', examples=['INPUT-METAMORPH-1'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Information about a metamorph event that occurred during the run."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 789,
+ 790,
+ 788,
+ 791,
+ 787
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 786,
+ "module": "_models",
+ "name": "Metamorph",
+ "parsedDocstring": {
+ "text": "Information about a metamorph event that occurred during the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1716
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 793,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1743
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 794,
+ "module": "_models",
+ "name": "usage_cycle",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1747
+ }
+ ],
+ "type": {
+ "name": "UsageCycle",
+ "type": "reference",
+ "target": "1391"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 795,
+ "module": "_models",
+ "name": "monthly_service_usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1748
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "UsageItem",
+ "target": "1395"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 796,
+ "module": "_models",
+ "name": "daily_service_usages",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1749
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DailyServiceUsages",
+ "target": "473"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 797,
+ "module": "_models",
+ "name": "total_usage_credits_usd_before_volume_discount",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1750
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 798,
+ "module": "_models",
+ "name": "total_usage_credits_usd_after_volume_discount",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1753
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 796,
+ 793,
+ 795,
+ 798,
+ 797,
+ 794
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 792,
+ "module": "_models",
+ "name": "MonthlyUsage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1742
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 800,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1760
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 801,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1764
+ }
+ ],
+ "type": {
+ "name": "MonthlyUsage",
+ "type": "reference",
+ "target": "792"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 801,
+ 800
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 799,
+ "module": "_models",
+ "name": "MonthlyUsageResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1759
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 803,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1771
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 804,
+ "module": "_models",
+ "name": "email",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1775
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Notification settings for this schedule."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 804,
+ 803
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 802,
+ "module": "_models",
+ "name": "Notifications",
+ "parsedDocstring": {
+ "text": "Notification settings for this schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1768
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 806,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1782
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 807,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 808,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 809,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 810,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 811,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Common pagination fields for list responses."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 811,
+ 810,
+ 809,
+ 806,
+ 808,
+ 807
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 805,
+ "module": "_models",
+ "name": "PaginationResponse",
+ "parsedDocstring": {
+ "text": "Common pagination fields for list responses."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1779
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "ListOfActors",
+ "target": "812",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfBuilds",
+ "target": "815",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfDatasets",
+ "target": "818",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfKeyValueStores",
+ "target": "822",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfRequestQueues",
+ "target": "826",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfRuns",
+ "target": "830",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfSchedules",
+ "target": "833",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfStoreActors",
+ "target": "836",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfTasks",
+ "target": "839",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfWebhookDispatches",
+ "target": "842",
+ "type": "reference"
+ },
+ {
+ "name": "ListOfWebhooks",
+ "target": "845",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 813,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1810
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 814,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1814
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorShort",
+ "target": "266"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4158,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4159,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4160,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4161,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4162,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4162,
+ 4161,
+ 814,
+ 4160,
+ 813,
+ 4159,
+ 4158
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 812,
+ "module": "_models",
+ "name": "ListOfActors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1809
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 816,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1819
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 817,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1823
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildShort",
+ "target": "358"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4163,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4164,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4165,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4166,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4167,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4167,
+ 4166,
+ 817,
+ 4165,
+ 816,
+ 4164,
+ 4163
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 815,
+ "module": "_models",
+ "name": "ListOfBuilds",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1818
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 819,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1828
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the listing was filtered to only unnamed datasets."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 820,
+ "module": "_models",
+ "name": "unnamed",
+ "parsedDocstring": {
+ "text": "Whether the listing was filtered to only unnamed datasets."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1832
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 821,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1836
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetListItem",
+ "target": "503"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4168,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4169,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4170,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4171,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4172,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4172,
+ 4171,
+ 821,
+ 4170,
+ 819,
+ 4169,
+ 4168,
+ 820
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 818,
+ "module": "_models",
+ "name": "ListOfDatasets",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1827
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 823,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1841
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the listing was filtered to only unnamed key-value stores."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 824,
+ "module": "_models",
+ "name": "unnamed",
+ "parsedDocstring": {
+ "text": "Whether the listing was filtered to only unnamed key-value stores."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1845
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 825,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1849
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStore",
+ "target": "647"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4173,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4174,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4175,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4176,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4177,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4177,
+ 4176,
+ 825,
+ 4175,
+ 823,
+ 4174,
+ 4173,
+ 824
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 822,
+ "module": "_models",
+ "name": "ListOfKeyValueStores",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1840
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 827,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1856
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the listing was filtered to only unnamed request queues."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 828,
+ "module": "_models",
+ "name": "unnamed",
+ "parsedDocstring": {
+ "text": "Whether the listing was filtered to only unnamed request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1860
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The array of request queues."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 829,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": "The array of request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1864
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueShort",
+ "target": "999"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4178,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4179,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4180,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4181,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4182,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A paginated list of request queues."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4182,
+ 4181,
+ 829,
+ 4180,
+ 827,
+ 4179,
+ 4178,
+ 828
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 826,
+ "module": "_models",
+ "name": "ListOfRequestQueues",
+ "parsedDocstring": {
+ "text": "A paginated list of request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1853
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 831,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1872
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 832,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1876
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunShort",
+ "target": "1090"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4183,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4184,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4185,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4186,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4187,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4187,
+ 4186,
+ 832,
+ 4185,
+ 831,
+ 4184,
+ 4183
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 830,
+ "module": "_models",
+ "name": "ListOfRuns",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1871
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 834,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1881
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 835,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1885
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleShort",
+ "target": "1235"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4188,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4189,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4190,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4191,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4192,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4192,
+ 4191,
+ 835,
+ 4190,
+ 834,
+ 4189,
+ 4188
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 833,
+ "module": "_models",
+ "name": "ListOfSchedules",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1880
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 837,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1890
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 838,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1894
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "StoreListActor",
+ "target": "1258"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4193,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4194,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4195,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4196,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4197,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4197,
+ 4196,
+ 838,
+ 4195,
+ 837,
+ 4194,
+ 4193
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 836,
+ "module": "_models",
+ "name": "ListOfStoreActors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1889
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 840,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1899
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 841,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1903
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskShort",
+ "target": "1314"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4198,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4199,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4200,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4201,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4202,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4202,
+ 4201,
+ 841,
+ 4200,
+ 840,
+ 4199,
+ 4198
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 839,
+ "module": "_models",
+ "name": "ListOfTasks",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1898
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 843,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1908
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 844,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1912
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatch",
+ "target": "1474"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4203,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4204,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4205,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4206,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4207,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4207,
+ 4206,
+ 844,
+ 4205,
+ 843,
+ 4204,
+ 4203
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 842,
+ "module": "_models",
+ "name": "ListOfWebhookDispatches",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1907
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 846,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1917
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "PaginationResponse.model_config",
+ "target": 806,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 847,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1921
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookShort",
+ "target": "1501"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of items available across all pages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4208,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "The total number of items available across all pages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1786
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.total",
+ "target": 807,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The starting position for this page of results."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4209,
+ "module": "_models",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The starting position for this page of results."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1790
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[0], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.offset",
+ "target": 808,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of items returned per page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4210,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of items returned per page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1000], ge=1)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.limit",
+ "target": 809,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the results are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4211,
+ "module": "_models",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the results are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1798
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool, Field(examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.desc",
+ "target": 810,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of items returned in this response."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4212,
+ "module": "_models",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "The number of items returned in this response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1802
+ }
+ ],
+ "type": {
+ "name": "Annotated[int, Field(examples=[1], ge=0)]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "PaginationResponse.count",
+ "target": 811,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4212,
+ 4211,
+ 847,
+ 4210,
+ 846,
+ 4209,
+ 4208
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 845,
+ "module": "_models",
+ "name": "ListOfWebhooks",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1916
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "PaginationResponse",
+ "target": "805",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 849,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1926
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "CommonActorPricingInfo.model_config",
+ "target": 399,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 850,
+ "module": "_models",
+ "name": "pricing_model",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1930
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "PAY_PER_EVENT"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 851,
+ "module": "_models",
+ "name": "pricing_per_event",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1931
+ }
+ ],
+ "type": {
+ "name": "PricingPerEvent",
+ "type": "reference",
+ "target": "893"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 852,
+ "module": "_models",
+ "name": "minimal_max_total_charge_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1932
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4229,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 620
+ }
+ ],
+ "type": {
+ "name": "Annotated[float, Field(alias='apifyMarginPercentage')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.apify_margin_percentage",
+ "target": 400,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When this pricing info record has been created"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4230,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "When this pricing info record has been created"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 624
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='createdAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.created_at",
+ "target": 401,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Since when is this pricing info record effective for a given Actor"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4231,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Since when is this pricing info record effective for a given Actor"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='startedAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.started_at",
+ "target": 402,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4232,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 632
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_future_change_at",
+ "target": 403,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4233,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_change_at",
+ "target": 404,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4234,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 634
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.reason_for_change",
+ "target": 405,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4235,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 635
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.is_price_change_notification_suppressed",
+ "target": 406,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4236,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 638
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.force_contains_significant_price_change",
+ "target": 407,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4229,
+ 4230,
+ 4236,
+ 4235,
+ 852,
+ 849,
+ 4233,
+ 4232,
+ 850,
+ 851,
+ 4234,
+ 4231
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 848,
+ "module": "_models",
+ "name": "PayPerEventActorPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1925
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "CommonActorPricingInfo",
+ "target": "398",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 854,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1937
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 855,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1941
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 856,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1942
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 857,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1943
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 858,
+ "module": "_models",
+ "name": "monthly_base_price_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1944
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 859,
+ "module": "_models",
+ "name": "monthly_usage_credits_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1945
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 860,
+ "module": "_models",
+ "name": "usage_discount_percent",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1946
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='usageDiscountPercent', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 861,
+ "module": "_models",
+ "name": "enabled_platform_features",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1947
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 862,
+ "module": "_models",
+ "name": "max_monthly_usage_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1953
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 863,
+ "module": "_models",
+ "name": "max_actor_memory_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1954
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 864,
+ "module": "_models",
+ "name": "max_monthly_actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1955
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 865,
+ "module": "_models",
+ "name": "max_monthly_residential_proxy_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1956
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 866,
+ "module": "_models",
+ "name": "max_monthly_proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1959
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 867,
+ "module": "_models",
+ "name": "max_monthly_external_data_transfer_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1960
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 868,
+ "module": "_models",
+ "name": "max_actor_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1963
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 869,
+ "module": "_models",
+ "name": "max_actor_task_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1964
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 870,
+ "module": "_models",
+ "name": "data_retention_days",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1965
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of available proxies in this group."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 871,
+ "module": "_models",
+ "name": "available_proxy_groups",
+ "parsedDocstring": {
+ "text": "The number of available proxies in this group."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1966
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 872,
+ "module": "_models",
+ "name": "team_account_seat_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1970
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 873,
+ "module": "_models",
+ "name": "support_level",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1971
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 874,
+ "module": "_models",
+ "name": "available_add_ons",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1972
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 875,
+ "module": "_models",
+ "name": "tier",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1973
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['FREE'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 876,
+ "module": "_models",
+ "name": "api_rate_limit_boosts",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1974
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='apiRateLimitBoosts', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 877,
+ "module": "_models",
+ "name": "max_schedule_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1975
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxScheduleCount', examples=[100])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 878,
+ "module": "_models",
+ "name": "max_concurrent_actor_runs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1976
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxConcurrentActorRuns', examples=[25])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Pricing details for this plan."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 879,
+ "module": "_models",
+ "name": "plan_pricing",
+ "parsedDocstring": {
+ "text": "Pricing details for this plan."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1977
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(alias='planPricing')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 876,
+ 874,
+ 871,
+ 870,
+ 856,
+ 861,
+ 855,
+ 857,
+ 868,
+ 863,
+ 869,
+ 878,
+ 864,
+ 867,
+ 866,
+ 865,
+ 862,
+ 877,
+ 854,
+ 858,
+ 859,
+ 879,
+ 873,
+ 872,
+ 875,
+ 860
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 853,
+ "module": "_models",
+ "name": "Plan",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1936
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 881,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1985
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "CommonActorPricingInfo.model_config",
+ "target": 399,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 882,
+ "module": "_models",
+ "name": "pricing_model",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1989
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "PRICE_PER_DATASET_ITEM"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the unit that is being charged"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 883,
+ "module": "_models",
+ "name": "unit_name",
+ "parsedDocstring": {
+ "text": "Name of the unit that is being charged"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1990
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present\non a pricing record."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 884,
+ "module": "_models",
+ "name": "price_per_unit_usd",
+ "parsedDocstring": {
+ "text": "Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present\non a pricing record."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1994
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='pricePerUnitUsd')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 885,
+ "module": "_models",
+ "name": "tiered_pricing",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2000
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, TieredPricingPerDatasetItemEntry] | None, Field(alias='tieredPricing')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "TieredPricingPerDatasetItemEntry",
+ "target": "1332"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4237,
+ "module": "_models",
+ "name": "apify_margin_percentage",
+ "parsedDocstring": {
+ "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 620
+ }
+ ],
+ "type": {
+ "name": "Annotated[float, Field(alias='apifyMarginPercentage')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.apify_margin_percentage",
+ "target": 400,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When this pricing info record has been created"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4238,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "When this pricing info record has been created"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 624
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='createdAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.created_at",
+ "target": 401,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Since when is this pricing info record effective for a given Actor"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4239,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Since when is this pricing info record effective for a given Actor"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime, Field(alias='startedAt')]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.started_at",
+ "target": 402,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4240,
+ "module": "_models",
+ "name": "notified_about_future_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 632
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_future_change_at",
+ "target": 403,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4241,
+ "module": "_models",
+ "name": "notified_about_change_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.notified_about_change_at",
+ "target": 404,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4242,
+ "module": "_models",
+ "name": "reason_for_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 634
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='reasonForChange')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.reason_for_change",
+ "target": 405,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4243,
+ "module": "_models",
+ "name": "is_price_change_notification_suppressed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 635
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='isPriceChangeNotificationSuppressed') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.is_price_change_notification_suppressed",
+ "target": 406,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4244,
+ "module": "_models",
+ "name": "force_contains_significant_price_change",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 638
+ }
+ ],
+ "type": {
+ "name": "Annotated[ bool | None, Field(alias='forceContainsSignificantPriceChange') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "CommonActorPricingInfo.force_contains_significant_price_change",
+ "target": 407,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4237,
+ 4238,
+ 4244,
+ 4243,
+ 881,
+ 4241,
+ 4240,
+ 884,
+ 882,
+ 4242,
+ 4239,
+ 885,
+ 883
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 880,
+ "module": "_models",
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1984
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "CommonActorPricingInfo",
+ "target": "398",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 887,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2005
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 888,
+ "module": "_models",
+ "name": "quantity_above",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2009
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 889,
+ "module": "_models",
+ "name": "discount_percent",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2010
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 890,
+ "module": "_models",
+ "name": "tier_quantity",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2011
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 891,
+ "module": "_models",
+ "name": "unit_price_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2012
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 892,
+ "module": "_models",
+ "name": "price_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2013
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 889,
+ 887,
+ 892,
+ 888,
+ 890,
+ 891
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 886,
+ "module": "_models",
+ "name": "PriceTiers",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2004
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 894,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2018
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 895,
+ "module": "_models",
+ "name": "actor_charge_events",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2022
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "ActorChargeEvent",
+ "target": "232"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 895,
+ 894
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 893,
+ "module": "_models",
+ "name": "PricingPerEvent",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2017
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 897,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2027
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 898,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2031
+ }
+ ],
+ "type": {
+ "name": "UserPrivateInfo",
+ "type": "reference",
+ "target": "1402"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 898,
+ 897
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 896,
+ "module": "_models",
+ "name": "PrivateUserDataResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2026
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 900,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2036
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 901,
+ "module": "_models",
+ "name": "bio",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2040
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['I started web scraping in 1985 using Altair BASIC.'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 902,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2041
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Jane Doe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 903,
+ "module": "_models",
+ "name": "picture_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2042
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field(alias='pictureUrl', examples=['https://apify.com/img/anonymous_user_picture.png']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 904,
+ "module": "_models",
+ "name": "github_username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2045
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='githubUsername', examples=['torvalds.'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 905,
+ "module": "_models",
+ "name": "website_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2046
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='websiteUrl', examples=['http://www.example.com'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 906,
+ "module": "_models",
+ "name": "twitter_username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2047
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='twitterUsername', examples=['@BillGates'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 901,
+ 904,
+ 900,
+ 902,
+ 903,
+ 906,
+ 905
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 899,
+ "module": "_models",
+ "name": "Profile",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2035
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 908,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2054
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 909,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2058
+ }
+ ],
+ "type": {
+ "name": "RequestLockInfo",
+ "type": "reference",
+ "target": "970"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing updated lock information after prolonging a request lock."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 909,
+ 908
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 907,
+ "module": "_models",
+ "name": "ProlongRequestLockResponse",
+ "parsedDocstring": {
+ "text": "Response containing updated lock information after prolonging a request lock."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2051
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 911,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2063
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 912,
+ "module": "_models",
+ "name": "password",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2067
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 913,
+ "module": "_models",
+ "name": "groups",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2068
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ProxyGroup",
+ "target": "914"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 913,
+ 911,
+ 912
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 910,
+ "module": "_models",
+ "name": "Proxy",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2062
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 915,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2073
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 916,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2077
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 917,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2078
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Group1 description'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 918,
+ "module": "_models",
+ "name": "available_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2079
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 918,
+ 917,
+ 915,
+ 916
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 914,
+ "module": "_models",
+ "name": "ProxyGroup",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2072
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 920,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2086
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 921,
+ "module": "_models",
+ "name": "aborted",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2090
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='ABORTED', examples=[2542])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 922,
+ "module": "_models",
+ "name": "failed",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2091
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='FAILED', examples=[1234])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 923,
+ "module": "_models",
+ "name": "succeeded",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2092
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='SUCCEEDED', examples=[732805])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 924,
+ "module": "_models",
+ "name": "timed_out",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2093
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='TIMED-OUT', examples=[12556])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 925,
+ "module": "_models",
+ "name": "total",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2094
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='TOTAL', examples=[749137])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Run status counts over the past 30 days."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 921,
+ 922,
+ 920,
+ 923,
+ 924,
+ 925
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 919,
+ "module": "_models",
+ "name": "PublicActorRunStats30Days",
+ "parsedDocstring": {
+ "text": "Run status counts over the past 30 days."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2083
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 927,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2099
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 928,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2103
+ }
+ ],
+ "type": {
+ "name": "UserPublicInfo",
+ "type": "reference",
+ "target": "1413"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 928,
+ 927
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 926,
+ "module": "_models",
+ "name": "PublicUserDataResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2098
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 930,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2108
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 931,
+ "module": "_models",
+ "name": "error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2112
+ }
+ ],
+ "type": {
+ "name": "DatasetSchemaValidationError",
+ "type": "reference",
+ "target": "522"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 931,
+ 930
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 929,
+ "module": "_models",
+ "name": "PutItemResponseError",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2107
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 933,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2122
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 933
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 932,
+ "module": "_models",
+ "name": "PutItemsRequest",
+ "parsedDocstring": {
+ "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2116
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 935,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2135
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 935
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 934,
+ "module": "_models",
+ "name": "PutRecordRequest",
+ "parsedDocstring": {
+ "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2129
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 937,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2148
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 937
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 936,
+ "module": "_models",
+ "name": "RecordResponse",
+ "parsedDocstring": {
+ "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2142
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 939,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2156
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 940,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2160
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 941,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2166
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['https://apify.com'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 942,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2170
+ }
+ ],
+ "type": {
+ "name": "HttpMethod | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpMethod",
+ "target": "1896"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 943,
+ "module": "_models",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2171
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 944,
+ "module": "_models",
+ "name": "loaded_url",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2175
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 945,
+ "module": "_models",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2179
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 946,
+ "module": "_models",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2183
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 947,
+ "module": "_models",
+ "name": "user_data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2187
+ }
+ ],
+ "type": {
+ "name": "Annotated[RequestUserData | None, Field(alias='userData')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestUserData",
+ "target": "1035"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 948,
+ "module": "_models",
+ "name": "no_retry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2188
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 949,
+ "module": "_models",
+ "name": "error_messages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2192
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 950,
+ "module": "_models",
+ "name": "handled_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2196
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 949,
+ 950,
+ 946,
+ 944,
+ 942,
+ 939,
+ 948,
+ 945,
+ 943,
+ 940,
+ 941,
+ 947
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 938,
+ "module": "_models",
+ "name": "RequestBase",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2155
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "Request",
+ "target": "951",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 952,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2206
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "RequestBase.model_config",
+ "target": 939,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 953,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2210
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4147,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2160
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.unique_key",
+ "target": 940,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4148,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2166
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['https://apify.com'])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.url",
+ "target": 941,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4149,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2170
+ }
+ ],
+ "type": {
+ "name": "HttpMethod | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpMethod",
+ "target": "1896"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.method",
+ "target": 942,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times this request has been retried."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4150,
+ "module": "_models",
+ "name": "retry_count",
+ "parsedDocstring": {
+ "text": "The number of times this request has been retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2171
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.retry_count",
+ "target": 943,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The final URL that was loaded, after redirects (if any)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4151,
+ "module": "_models",
+ "name": "loaded_url",
+ "parsedDocstring": {
+ "text": "The final URL that was loaded, after redirects (if any)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2175
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.loaded_url",
+ "target": 944,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request payload, typically used with POST or PUT requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4152,
+ "module": "_models",
+ "name": "payload",
+ "parsedDocstring": {
+ "text": "The request payload, typically used with POST or PUT requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2179
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.payload",
+ "target": 945,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP headers sent with the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4153,
+ "module": "_models",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "HTTP headers sent with the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2183
+ }
+ ],
+ "type": {
+ "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.headers",
+ "target": 946,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4154,
+ "module": "_models",
+ "name": "user_data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2187
+ }
+ ],
+ "type": {
+ "name": "Annotated[RequestUserData | None, Field(alias='userData')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestUserData",
+ "target": "1035"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.user_data",
+ "target": 947,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether the request should not be retried if processing fails."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4155,
+ "module": "_models",
+ "name": "no_retry",
+ "parsedDocstring": {
+ "text": "Indicates whether the request should not be retried if processing fails."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2188
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.no_retry",
+ "target": 948,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Error messages recorded from failed processing attempts."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4156,
+ "module": "_models",
+ "name": "error_messages",
+ "parsedDocstring": {
+ "text": "Error messages recorded from failed processing attempts."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2192
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.error_messages",
+ "target": 949,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4157,
+ "module": "_models",
+ "name": "handled_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request was marked as handled, if applicable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2196
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "RequestBase.handled_at",
+ "target": 950,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4156,
+ 4157,
+ 4153,
+ 953,
+ 4151,
+ 4149,
+ 952,
+ 4155,
+ 4152,
+ 4150,
+ 4147,
+ 4148,
+ 4154
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 951,
+ "module": "_models",
+ "name": "Request",
+ "parsedDocstring": {
+ "text": "A request stored in the request queue, including its metadata and processing state."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2203
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "RequestBase",
+ "target": "938",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 955,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2220
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 956,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2224
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 957,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2228
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 958,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": "The URL of the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2232
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 959,
+ "module": "_models",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2236
+ }
+ ],
+ "type": {
+ "name": "HttpMethod | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpMethod",
+ "target": "1896"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 956,
+ 959,
+ 955,
+ 957,
+ 958
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 954,
+ "module": "_models",
+ "name": "RequestDraft",
+ "parsedDocstring": {
+ "text": "A request that failed to be processed during a request queue operation and can be retried."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2217
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 961,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2243
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 962,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2247
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 963,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2251
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 962,
+ 961,
+ 963
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 960,
+ "module": "_models",
+ "name": "RequestDraftDeleteById",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2240
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 965,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2263
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 966,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2267
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 967,
+ "module": "_models",
+ "name": "unique_key",
+ "parsedDocstring": {
+ "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2271
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted, identified by its unique key."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 966,
+ 965,
+ 967
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 964,
+ "module": "_models",
+ "name": "RequestDraftDeleteByUniqueKey",
+ "parsedDocstring": {
+ "text": "A request that should be deleted, identified by its unique key."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2260
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request that should be deleted."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 969,
+ "module": "_models",
+ "name": "root",
+ "parsedDocstring": {
+ "text": "A request that should be deleted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2279
+ }
+ ],
+ "type": {
+ "name": "Annotated[RequestDraftDeleteById | RequestDraftDeleteByUniqueKey, Field(title='RequestDraftDelete')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteById",
+ "target": "960"
+ },
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteByUniqueKey",
+ "target": "964"
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 969
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 968,
+ "module": "_models",
+ "name": "RequestDraftDelete",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2278
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 971,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2289
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the lock on this request expires."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 972,
+ "module": "_models",
+ "name": "lock_expires_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the lock on this request expires."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2293
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Information about a request lock."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 972,
+ 971
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 970,
+ "module": "_models",
+ "name": "RequestLockInfo",
+ "parsedDocstring": {
+ "text": "Information about a request lock."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2286
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 974,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2303
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 975,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2307
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 976,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": "The name of the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2311
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['some-name'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the user who owns the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 977,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": "The ID of the user who owns the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2315
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the Actor that created this request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 978,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": "The ID of the Actor that created this request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2319
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the Actor run that created this request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 979,
+ "module": "_models",
+ "name": "act_run_id",
+ "parsedDocstring": {
+ "text": "The ID of the Actor run that created this request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2323
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actRunId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was created."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 980,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was created."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2327
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 981,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2331
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last accessed."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 982,
+ "module": "_models",
+ "name": "accessed_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last accessed."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2335
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 983,
+ "module": "_models",
+ "name": "total_request_count",
+ "parsedDocstring": {
+ "text": "The total number of requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2339
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of requests that have been handled."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 984,
+ "module": "_models",
+ "name": "handled_request_count",
+ "parsedDocstring": {
+ "text": "The number of requests that have been handled."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2343
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of requests that are pending and have not been handled yet."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 985,
+ "module": "_models",
+ "name": "pending_request_count",
+ "parsedDocstring": {
+ "text": "The number of requests that are pending and have not been handled yet."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2347
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 986,
+ "module": "_models",
+ "name": "had_multiple_clients",
+ "parsedDocstring": {
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2351
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL to view the request queue in the Apify console."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 987,
+ "module": "_models",
+ "name": "console_url",
+ "parsedDocstring": {
+ "text": "The URL to view the request queue in the Apify console."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2355
+ }
+ ],
+ "type": {
+ "name": "AnyUrl",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 988,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2361
+ }
+ ],
+ "type": {
+ "name": "RequestQueueStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestQueueStats",
+ "target": "1017"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 989,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2362
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A request queue object containing metadata and statistics."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 982,
+ 978,
+ 979,
+ 987,
+ 980,
+ 989,
+ 986,
+ 984,
+ 975,
+ 974,
+ 981,
+ 976,
+ 985,
+ 988,
+ 983,
+ 977
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 973,
+ "module": "_models",
+ "name": "RequestQueue",
+ "parsedDocstring": {
+ "text": "A request queue object containing metadata and statistics."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2300
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 991,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2369
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of requests returned."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 992,
+ "module": "_models",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The maximum number of requests returned."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2373
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 993,
+ "module": "_models",
+ "name": "queue_modified_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2377
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 994,
+ "module": "_models",
+ "name": "had_multiple_clients",
+ "parsedDocstring": {
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2381
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The array of requests from the request queue head."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 995,
+ "module": "_models",
+ "name": "items",
+ "parsedDocstring": {
+ "text": "The array of requests from the request queue head."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2385
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "HeadRequest",
+ "target": "633"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A batch of requests from the request queue head without locking."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 994,
+ 995,
+ 992,
+ 991,
+ 993
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 990,
+ "module": "_models",
+ "name": "RequestQueueHead",
+ "parsedDocstring": {
+ "text": "A batch of requests from the request queue head without locking."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2366
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 997,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2395
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 998,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2399
+ }
+ ],
+ "type": {
+ "name": "RequestQueue",
+ "type": "reference",
+ "target": "973"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing request queue data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 998,
+ 997
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 996,
+ "module": "_models",
+ "name": "RequestQueueResponse",
+ "parsedDocstring": {
+ "text": "Response containing request queue data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2392
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1000,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2406
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1001,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2410
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1002,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": "The name of the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2414
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the user who owns the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1003,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": "The ID of the user who owns the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2418
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The username of the user who owns the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1004,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": "The username of the user who owns the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2422
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was created."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1005,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was created."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2426
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1006,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2430
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue was last accessed."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1007,
+ "module": "_models",
+ "name": "accessed_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue was last accessed."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2434
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the request queue will expire and be deleted."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1008,
+ "module": "_models",
+ "name": "expire_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the request queue will expire and be deleted."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2438
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='expireAt', examples=['2019-06-02T17:15:06.751Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of requests in the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1009,
+ "module": "_models",
+ "name": "total_request_count",
+ "parsedDocstring": {
+ "text": "The total number of requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2442
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of requests that have been handled."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1010,
+ "module": "_models",
+ "name": "handled_request_count",
+ "parsedDocstring": {
+ "text": "The number of requests that have been handled."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2446
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of requests that are pending and have not been handled yet."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1011,
+ "module": "_models",
+ "name": "pending_request_count",
+ "parsedDocstring": {
+ "text": "The number of requests that are pending and have not been handled yet."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2450
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the Actor that created this request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1012,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": "The ID of the Actor that created this request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2454
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the Actor run that created this request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1013,
+ "module": "_models",
+ "name": "act_run_id",
+ "parsedDocstring": {
+ "text": "The ID of the Actor run that created this request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2458
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actRunId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1014,
+ "module": "_models",
+ "name": "had_multiple_clients",
+ "parsedDocstring": {
+ "text": "Whether the request queue has been accessed by multiple different clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2462
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1015,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2466
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1016,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2467
+ }
+ ],
+ "type": {
+ "name": "RequestQueueStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestQueueStats",
+ "target": "1017"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A shortened request queue object for list responses."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1007,
+ 1012,
+ 1013,
+ 1005,
+ 1008,
+ 1015,
+ 1014,
+ 1010,
+ 1001,
+ 1000,
+ 1006,
+ 1002,
+ 1011,
+ 1016,
+ 1009,
+ 1003,
+ 1004
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 999,
+ "module": "_models",
+ "name": "RequestQueueShort",
+ "parsedDocstring": {
+ "text": "A shortened request queue object for list responses."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2403
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1018,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2474
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of delete operations performed on the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1019,
+ "module": "_models",
+ "name": "delete_count",
+ "parsedDocstring": {
+ "text": "The number of delete operations performed on the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2478
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='deleteCount', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of times requests from the head were read."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1020,
+ "module": "_models",
+ "name": "head_item_read_count",
+ "parsedDocstring": {
+ "text": "The number of times requests from the head were read."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2482
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='headItemReadCount', examples=[5])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of read operations performed on the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1021,
+ "module": "_models",
+ "name": "read_count",
+ "parsedDocstring": {
+ "text": "The total number of read operations performed on the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2486
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='readCount', examples=[100])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total storage size in bytes used by the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1022,
+ "module": "_models",
+ "name": "storage_bytes",
+ "parsedDocstring": {
+ "text": "The total storage size in bytes used by the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2490
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='storageBytes', examples=[1024])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The total number of write operations performed on the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1023,
+ "module": "_models",
+ "name": "write_count",
+ "parsedDocstring": {
+ "text": "The total number of write operations performed on the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2494
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='writeCount', examples=[10])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics about request queue operations and storage."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1019,
+ 1020,
+ 1018,
+ 1021,
+ 1022,
+ 1023
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1017,
+ "module": "_models",
+ "name": "RequestQueueStats",
+ "parsedDocstring": {
+ "text": "Statistics about request queue operations and storage."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2471
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1025,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2504
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default request queue for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1026,
+ "module": "_models",
+ "name": "default",
+ "parsedDocstring": {
+ "text": "ID of the default request queue for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2508
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['FL35cSF7jrxr3BY39'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased request queue IDs for this run."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1026,
+ 1025
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1024,
+ "module": "_models",
+ "name": "RequestQueues",
+ "parsedDocstring": {
+ "text": "Aliased request queue IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2501
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1028,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2518
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier assigned to the request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1029,
+ "module": "_models",
+ "name": "request_id",
+ "parsedDocstring": {
+ "text": "A unique identifier assigned to the request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2522
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1030,
+ "module": "_models",
+ "name": "was_already_present",
+ "parsedDocstring": {
+ "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2526
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates whether a request with the same unique key has already been processed by the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1031,
+ "module": "_models",
+ "name": "was_already_handled",
+ "parsedDocstring": {
+ "text": "Indicates whether a request with the same unique key has already been processed by the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2530
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1028,
+ 1029,
+ 1031,
+ 1030
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1027,
+ "module": "_models",
+ "name": "RequestRegistration",
+ "parsedDocstring": {
+ "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2515
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1033,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2540
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1034,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2544
+ }
+ ],
+ "type": {
+ "name": "Request",
+ "type": "reference",
+ "target": "951"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing a single request from the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1034,
+ 1033
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1032,
+ "module": "_models",
+ "name": "RequestResponse",
+ "parsedDocstring": {
+ "text": "Response containing a single request from the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2537
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1036,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2551
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Custom user data attached to the request. Can contain arbitrary fields."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1036
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1035,
+ "module": "_models",
+ "name": "RequestUserData",
+ "parsedDocstring": {
+ "text": "Custom user data attached to the request. Can contain arbitrary fields."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2548
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1038,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2561
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Unique identifier of the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1039,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": "Unique identifier of the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2565
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the Actor that was run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1040,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": "ID of the Actor that was run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2569
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the user who started the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1041,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": "ID of the user who started the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2573
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the Actor task, if the run was started from a task."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1042,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": "ID of the Actor task, if the run was started from a task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2577
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Time when the Actor run started."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1043,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": "Time when the Actor run started."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2581
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Time when the Actor run finished."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1044,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": "Time when the Actor run finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2585
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Current status of the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1045,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": "Current status of the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2591
+ }
+ ],
+ "type": {
+ "name": "ActorJobStatus",
+ "type": "reference",
+ "target": "1892"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Detailed message about the run status."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1046,
+ "module": "_models",
+ "name": "status_message",
+ "parsedDocstring": {
+ "text": "Detailed message about the run status."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2595
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor is running'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the status message is terminal (final)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1047,
+ "module": "_models",
+ "name": "is_status_message_terminal",
+ "parsedDocstring": {
+ "text": "Whether the status message is terminal (final)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2599
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Metadata about the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1048,
+ "module": "_models",
+ "name": "meta",
+ "parsedDocstring": {
+ "text": "Metadata about the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2603
+ }
+ ],
+ "type": {
+ "name": "RunMeta",
+ "type": "reference",
+ "target": "1072"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Pricing information for the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1049,
+ "module": "_models",
+ "name": "pricing_info",
+ "parsedDocstring": {
+ "text": "Pricing information for the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2607
+ }
+ ],
+ "type": {
+ "name": "Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo | None, Field(alias='pricingInfo', discriminator='pricing_model', title='ActorRunPricingInfo'), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "PayPerEventActorPricingInfo",
+ "target": "848"
+ },
+ {
+ "type": "reference",
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "target": "880"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "target": "622"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FreeActorPricingInfo",
+ "target": "627"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics of the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1050,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": "Statistics of the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2618
+ }
+ ],
+ "type": {
+ "name": "RunStats",
+ "type": "reference",
+ "target": "1107"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1051,
+ "module": "_models",
+ "name": "charged_event_counts",
+ "parsedDocstring": {
+ "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2622
+ }
+ ],
+ "type": {
+ "name": "Annotated[ dict[str, int] | None, Field(alias='chargedEventCounts', examples=[{'actor-start': 1, 'page-crawled': 150, 'data-extracted': 75}]), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Configuration options for the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1052,
+ "module": "_models",
+ "name": "options",
+ "parsedDocstring": {
+ "text": "Configuration options for the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2629
+ }
+ ],
+ "type": {
+ "name": "RunOptions",
+ "type": "reference",
+ "target": "1079"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the Actor build used for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1053,
+ "module": "_models",
+ "name": "build_id",
+ "parsedDocstring": {
+ "text": "ID of the Actor build used for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2633
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Exit code of the Actor run process."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1054,
+ "module": "_models",
+ "name": "exit_code",
+ "parsedDocstring": {
+ "text": "Exit code of the Actor run process."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2637
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='exitCode', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "General access level for the Actor run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1055,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": "General access level for the Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2641
+ }
+ ],
+ "type": {
+ "name": "GeneralAccess",
+ "type": "reference",
+ "target": "1895"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default key-value store for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1056,
+ "module": "_models",
+ "name": "default_key_value_store_id",
+ "parsedDocstring": {
+ "text": "ID of the default key-value store for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2645
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default dataset for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1057,
+ "module": "_models",
+ "name": "default_dataset_id",
+ "parsedDocstring": {
+ "text": "ID of the default dataset for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2649
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the default request queue for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1058,
+ "module": "_models",
+ "name": "default_request_queue_id",
+ "parsedDocstring": {
+ "text": "ID of the default request queue for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2653
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A map of aliased storage IDs associated with this run, grouped by storage type."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1059,
+ "module": "_models",
+ "name": "storage_ids",
+ "parsedDocstring": {
+ "text": "A map of aliased storage IDs associated with this run, grouped by storage type."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2657
+ }
+ ],
+ "type": {
+ "name": "Annotated[StorageIds | None, Field(alias='storageIds')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageIds",
+ "target": "1250"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Build number of the Actor build used for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1060,
+ "module": "_models",
+ "name": "build_number",
+ "parsedDocstring": {
+ "text": "Build number of the Actor build used for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2661
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field( alias='buildNumber', examples=['0.0.36'], pattern='^([0-9]|[1-9][0-9])\\\\.([0-9]|[1-9][0-9])(\\\\.[1-9][0-9]{0,4})$', ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the container running the Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1061,
+ "module": "_models",
+ "name": "container_url",
+ "parsedDocstring": {
+ "text": "URL of the container running the Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2672
+ }
+ ],
+ "type": {
+ "name": "Annotated[ AnyUrl | None, Field(alias='containerUrl', examples=['https://g8kd8kbc5ge8.runs.apify.net']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the container's HTTP server is ready to accept requests."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1062,
+ "module": "_models",
+ "name": "is_container_server_ready",
+ "parsedDocstring": {
+ "text": "Whether the container's HTTP server is ready to accept requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2678
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isContainerServerReady', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the git branch used for the Actor build."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1063,
+ "module": "_models",
+ "name": "git_branch_name",
+ "parsedDocstring": {
+ "text": "Name of the git branch used for the Actor build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2682
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='gitBranchName', examples=['master'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource usage statistics for the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1064,
+ "module": "_models",
+ "name": "usage",
+ "parsedDocstring": {
+ "text": "Resource usage statistics for the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2686
+ }
+ ],
+ "type": {
+ "name": "RunUsage | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunUsage",
+ "target": "1129"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1065,
+ "module": "_models",
+ "name": "usage_total_usd",
+ "parsedDocstring": {
+ "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2690
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.2654])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1066,
+ "module": "_models",
+ "name": "usage_usd",
+ "parsedDocstring": {
+ "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2694
+ }
+ ],
+ "type": {
+ "name": "Annotated[RunUsageUsd | None, Field(alias='usageUsd')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunUsageUsd",
+ "target": "1143"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of metamorph events that occurred during the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1067,
+ "module": "_models",
+ "name": "metamorphs",
+ "parsedDocstring": {
+ "text": "List of metamorph events that occurred during the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2698
+ }
+ ],
+ "type": {
+ "name": "list[Metamorph] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Metamorph",
+ "target": "786"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Indicates which party covers platform usage costs for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1068,
+ "module": "_models",
+ "name": "platform_usage_billing_model",
+ "parsedDocstring": {
+ "text": "Indicates which party covers platform usage costs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2702
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='platformUsageBillingModel', examples=['USER'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Represents an Actor run and its associated data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1040,
+ 1042,
+ 1053,
+ 1060,
+ 1051,
+ 1061,
+ 1057,
+ 1056,
+ 1058,
+ 1054,
+ 1044,
+ 1055,
+ 1063,
+ 1039,
+ 1062,
+ 1047,
+ 1048,
+ 1067,
+ 1038,
+ 1052,
+ 1068,
+ 1049,
+ 1043,
+ 1050,
+ 1045,
+ 1046,
+ 1059,
+ 1064,
+ 1065,
+ 1066,
+ 1041
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1037,
+ "module": "_models",
+ "name": "Run",
+ "parsedDocstring": {
+ "text": "Represents an Actor run and its associated data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2558
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1070,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2712
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "ErrorDetail.model_config",
+ "target": 603,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Machine-processable error type identifier."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1071,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": "Machine-processable error type identifier."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2716
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "run-failed"
+ }
+ ]
+ },
+ "overwrites": {
+ "name": "ErrorDetail.type",
+ "target": 604,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Human-readable error message describing what went wrong."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4145,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": "Human-readable error message describing what went wrong."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1158
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ErrorDetail.message",
+ "target": 605,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4145,
+ 1070,
+ 1071
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1069,
+ "module": "_models",
+ "name": "RunFailedErrorDetail",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2711
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ErrorDetail",
+ "target": "602",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1073,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2724
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1074,
+ "module": "_models",
+ "name": "origin",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2728
+ }
+ ],
+ "type": {
+ "name": "RunOrigin",
+ "type": "reference",
+ "target": "1897"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "IP address of the client that started the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1075,
+ "module": "_models",
+ "name": "client_ip",
+ "parsedDocstring": {
+ "text": "IP address of the client that started the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2729
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='clientIp')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "User agent of the client that started the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1076,
+ "module": "_models",
+ "name": "user_agent",
+ "parsedDocstring": {
+ "text": "User agent of the client that started the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2733
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='userAgent')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the schedule that triggered the run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1077,
+ "module": "_models",
+ "name": "schedule_id",
+ "parsedDocstring": {
+ "text": "ID of the schedule that triggered the run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2737
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='scheduleId')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Time when the run was scheduled."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1078,
+ "module": "_models",
+ "name": "scheduled_at",
+ "parsedDocstring": {
+ "text": "Time when the run was scheduled."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2741
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='scheduledAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1075,
+ 1073,
+ 1074,
+ 1077,
+ 1078,
+ 1076
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1072,
+ "module": "_models",
+ "name": "RunMeta",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2723
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1080,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2749
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1081,
+ "module": "_models",
+ "name": "build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2753
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1082,
+ "module": "_models",
+ "name": "timeout_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2754
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1083,
+ "module": "_models",
+ "name": "memory_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2755
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1084,
+ "module": "_models",
+ "name": "disk_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2756
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1085,
+ "module": "_models",
+ "name": "max_items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2757
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000], ge=1)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1086,
+ "module": "_models",
+ "name": "max_total_charge_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2758
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5], ge=0.0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1081,
+ 1084,
+ 1085,
+ 1086,
+ 1083,
+ 1080,
+ 1082
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1079,
+ "module": "_models",
+ "name": "RunOptions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2748
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1088,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2763
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1089,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2767
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1089,
+ 1088
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1087,
+ "module": "_models",
+ "name": "RunResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2762
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1091,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2772
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1092,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2776
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1093,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2777
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1094,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2778
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='userId', examples=['7sT5jcggjjA9fNcxF'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1095,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2779
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1096,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2780
+ }
+ ],
+ "type": {
+ "name": "ActorJobStatus",
+ "type": "reference",
+ "target": "1892"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1097,
+ "module": "_models",
+ "name": "started_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2781
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1098,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2782
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1099,
+ "module": "_models",
+ "name": "build_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2785
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1100,
+ "module": "_models",
+ "name": "build_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2786
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field( alias='buildNumber', examples=['0.0.2'], pattern='^([0-9]|[1-9][0-9])\\\\.([0-9]|[1-9][0-9])(\\\\.[1-9][0-9]{0,4})$', ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1101,
+ "module": "_models",
+ "name": "build_number_int",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2794
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='buildNumberInt', examples=[10000])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1102,
+ "module": "_models",
+ "name": "meta",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2795
+ }
+ ],
+ "type": {
+ "name": "RunMeta",
+ "type": "reference",
+ "target": "1072"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1103,
+ "module": "_models",
+ "name": "usage_total_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2796
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1104,
+ "module": "_models",
+ "name": "default_key_value_store_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2797
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1105,
+ "module": "_models",
+ "name": "default_dataset_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2798
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1106,
+ "module": "_models",
+ "name": "default_request_queue_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2799
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1093,
+ 1095,
+ 1099,
+ 1100,
+ 1101,
+ 1105,
+ 1104,
+ 1106,
+ 1098,
+ 1092,
+ 1102,
+ 1091,
+ 1097,
+ 1096,
+ 1103,
+ 1094
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1090,
+ "module": "_models",
+ "name": "RunShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2771
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1108,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2804
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1109,
+ "module": "_models",
+ "name": "input_body_len",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2808
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='inputBodyLen', examples=[240], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1110,
+ "module": "_models",
+ "name": "migration_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2809
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='migrationCount', examples=[0], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1111,
+ "module": "_models",
+ "name": "reboot_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2810
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='rebootCount', examples=[0], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1112,
+ "module": "_models",
+ "name": "restart_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2811
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1113,
+ "module": "_models",
+ "name": "resurrect_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2812
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1114,
+ "module": "_models",
+ "name": "mem_avg_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2813
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='memAvgBytes', examples=[267874071.9])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1115,
+ "module": "_models",
+ "name": "mem_max_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2814
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memMaxBytes', examples=[404713472], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1116,
+ "module": "_models",
+ "name": "mem_current_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2815
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memCurrentBytes', examples=[0], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1117,
+ "module": "_models",
+ "name": "cpu_avg_usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2816
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='cpuAvgUsage', examples=[33.7532101107538])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1118,
+ "module": "_models",
+ "name": "cpu_max_usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2817
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='cpuMaxUsage', examples=[169.650735534941])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1119,
+ "module": "_models",
+ "name": "cpu_current_usage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2818
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='cpuCurrentUsage', examples=[0])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1120,
+ "module": "_models",
+ "name": "net_rx_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2819
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='netRxBytes', examples=[103508042], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1121,
+ "module": "_models",
+ "name": "net_tx_bytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2820
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='netTxBytes', examples=[4854600], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1122,
+ "module": "_models",
+ "name": "duration_millis",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2821
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='durationMillis', examples=[248472], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1123,
+ "module": "_models",
+ "name": "run_time_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2822
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[248.472], ge=0.0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1124,
+ "module": "_models",
+ "name": "metamorph",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2823
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(examples=[0], ge=0)]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1125,
+ "module": "_models",
+ "name": "compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2824
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1125,
+ 1117,
+ 1119,
+ 1118,
+ 1122,
+ 1109,
+ 1114,
+ 1116,
+ 1115,
+ 1124,
+ 1110,
+ 1108,
+ 1120,
+ 1121,
+ 1111,
+ 1112,
+ 1113,
+ 1123
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1107,
+ "module": "_models",
+ "name": "RunStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2803
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1127,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2829
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "ErrorDetail.model_config",
+ "target": 603,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Machine-processable error type identifier."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1128,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": "Machine-processable error type identifier."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2833
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "run-timeout-exceeded"
+ }
+ ]
+ },
+ "overwrites": {
+ "name": "ErrorDetail.type",
+ "target": 604,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Human-readable error message describing what went wrong."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4146,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": "Human-readable error message describing what went wrong."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1158
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ErrorDetail.message",
+ "target": 605,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4146,
+ 1127,
+ 1128
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1126,
+ "module": "_models",
+ "name": "RunTimeoutExceededErrorDetail",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2828
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ErrorDetail",
+ "target": "602",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1130,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2841
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1131,
+ "module": "_models",
+ "name": "actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2845
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[3])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1132,
+ "module": "_models",
+ "name": "dataset_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2846
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='DATASET_READS', examples=[4])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1133,
+ "module": "_models",
+ "name": "dataset_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2847
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='DATASET_WRITES', examples=[4])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1134,
+ "module": "_models",
+ "name": "key_value_store_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2848
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_READS', examples=[5])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1135,
+ "module": "_models",
+ "name": "key_value_store_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2849
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[3])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1136,
+ "module": "_models",
+ "name": "key_value_store_lists",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2850
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[5])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1137,
+ "module": "_models",
+ "name": "request_queue_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2851
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_READS', examples=[2])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1138,
+ "module": "_models",
+ "name": "request_queue_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2852
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[1])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1139,
+ "module": "_models",
+ "name": "data_transfer_internal_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2853
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[1]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1140,
+ "module": "_models",
+ "name": "data_transfer_external_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2856
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[3]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1141,
+ "module": "_models",
+ "name": "proxy_residential_transfer_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2859
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[34]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1142,
+ "module": "_models",
+ "name": "proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2862
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='PROXY_SERPS', examples=[3])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1131,
+ 1140,
+ 1139,
+ 1132,
+ 1133,
+ 1136,
+ 1134,
+ 1135,
+ 1130,
+ 1141,
+ 1142,
+ 1137,
+ 1138
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1129,
+ "module": "_models",
+ "name": "RunUsage",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2840
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1144,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2869
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1145,
+ "module": "_models",
+ "name": "actor_compute_units",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2873
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.0003])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1146,
+ "module": "_models",
+ "name": "dataset_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2874
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='DATASET_READS', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1147,
+ "module": "_models",
+ "name": "dataset_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2875
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='DATASET_WRITES', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1148,
+ "module": "_models",
+ "name": "key_value_store_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2876
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_READS', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1149,
+ "module": "_models",
+ "name": "key_value_store_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2877
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[5e-05])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1150,
+ "module": "_models",
+ "name": "key_value_store_lists",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2878
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1151,
+ "module": "_models",
+ "name": "request_queue_reads",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2879
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_READS', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1152,
+ "module": "_models",
+ "name": "request_queue_writes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2880
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[0.0001])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1153,
+ "module": "_models",
+ "name": "data_transfer_internal_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2881
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[0.001]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1154,
+ "module": "_models",
+ "name": "data_transfer_external_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2884
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[0.003]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1155,
+ "module": "_models",
+ "name": "proxy_residential_transfer_gbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2887
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[0.034]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1156,
+ "module": "_models",
+ "name": "proxy_serps",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2890
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='PROXY_SERPS', examples=[0.003])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource usage costs in USD. All values are monetary amounts in US dollars."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1145,
+ 1154,
+ 1153,
+ 1146,
+ 1147,
+ 1150,
+ 1148,
+ 1149,
+ 1144,
+ 1155,
+ 1156,
+ 1151,
+ 1152
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1143,
+ "module": "_models",
+ "name": "RunUsageUsd",
+ "parsedDocstring": {
+ "text": "Resource usage costs in USD. All values are monetary amounts in US dollars."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2866
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1158,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2895
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1159,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2899
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1160,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2900
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1161,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2901
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1162,
+ "module": "_models",
+ "name": "run_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2902
+ }
+ ],
+ "type": {
+ "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ScheduleActionRunInput",
+ "target": "1170"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1163,
+ "module": "_models",
+ "name": "run_options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2903
+ }
+ ],
+ "type": {
+ "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskOptions",
+ "target": "1303"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1161,
+ 1159,
+ 1158,
+ 1162,
+ 1163,
+ 1160
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1157,
+ "module": "_models",
+ "name": "ScheduleActionRunActor",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2894
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1165,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2908
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1166,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2912
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1167,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2913
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR_TASK"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1168,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2914
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1169,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2915
+ }
+ ],
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1168,
+ 1166,
+ 1169,
+ 1165,
+ 1167
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1164,
+ "module": "_models",
+ "name": "ScheduleActionRunActorTask",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2907
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1171,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2920
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1172,
+ "module": "_models",
+ "name": "body",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2924
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['{\\\\n \"foo\": \"actor\"\\\\n}'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1173,
+ "module": "_models",
+ "name": "content_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2925
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1172,
+ 1173,
+ 1171
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1170,
+ "module": "_models",
+ "name": "ScheduleActionRunInput",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2919
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1175,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2930
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1176,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2934
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1177,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2935
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1178,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2936
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1178,
+ 1176,
+ 1175,
+ 1177
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1174,
+ "module": "_models",
+ "name": "ScheduleActionShortRunActor",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2929
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1180,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2941
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1181,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2945
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1182,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2946
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR_TASK"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1183,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2947
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1183,
+ 1181,
+ 1180,
+ 1182
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1179,
+ "module": "_models",
+ "name": "ScheduleActionShortRunActorTask",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2940
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1185,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2952
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1186,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2956
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1187,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2957
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1188,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2958
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1189,
+ "module": "_models",
+ "name": "cron_expression",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2959
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1190,
+ "module": "_models",
+ "name": "timezone",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2960
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1191,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2961
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1192,
+ "module": "_models",
+ "name": "is_exclusive",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2962
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1193,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2963
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1194,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2964
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1195,
+ "module": "_models",
+ "name": "next_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2965
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1196,
+ "module": "_models",
+ "name": "last_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2966
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1193,
+ 1189,
+ 1186,
+ 1191,
+ 1192,
+ 1196,
+ 1185,
+ 1194,
+ 1188,
+ 1195,
+ 1190,
+ 1187
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1184,
+ "module": "_models",
+ "name": "ScheduleBase",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2951
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "Schedule",
+ "target": "1197",
+ "type": "reference"
+ },
+ {
+ "name": "ScheduleShort",
+ "target": "1235",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1198,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2971
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "ScheduleBase.model_config",
+ "target": 1185,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1199,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2975
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1200,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2976
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Notification settings for this schedule."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1201,
+ "module": "_models",
+ "name": "notifications",
+ "parsedDocstring": {
+ "text": "Notification settings for this schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2977
+ }
+ ],
+ "type": {
+ "name": "Annotated[Notifications | None, Field(title='ScheduleNotifications')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Notifications",
+ "target": "802"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1202,
+ "module": "_models",
+ "name": "actions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2981
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ScheduleActionRunActor",
+ "target": "1157"
+ },
+ {
+ "type": "reference",
+ "name": "ScheduleActionRunActorTask",
+ "target": "1164"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4123,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2956
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.id",
+ "target": 1186,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4124,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2957
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.user_id",
+ "target": 1187,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4125,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2958
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.name",
+ "target": 1188,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4126,
+ "module": "_models",
+ "name": "cron_expression",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2959
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.cron_expression",
+ "target": 1189,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4127,
+ "module": "_models",
+ "name": "timezone",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2960
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.timezone",
+ "target": 1190,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4128,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2961
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.is_enabled",
+ "target": 1191,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4129,
+ "module": "_models",
+ "name": "is_exclusive",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2962
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.is_exclusive",
+ "target": 1192,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4130,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2963
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.created_at",
+ "target": 1193,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4131,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2964
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.modified_at",
+ "target": 1194,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4132,
+ "module": "_models",
+ "name": "next_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2965
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.next_run_at",
+ "target": 1195,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4133,
+ "module": "_models",
+ "name": "last_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2966
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.last_run_at",
+ "target": 1196,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1202,
+ 4130,
+ 4126,
+ 1199,
+ 4123,
+ 4128,
+ 4129,
+ 4133,
+ 1198,
+ 4131,
+ 4125,
+ 4132,
+ 1201,
+ 4127,
+ 1200,
+ 4124
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1197,
+ "module": "_models",
+ "name": "Schedule",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2970
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ScheduleBase",
+ "target": "1184",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1204,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2986
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1205,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2990
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['my-schedule'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1206,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2991
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isEnabled', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1207,
+ "module": "_models",
+ "name": "is_exclusive",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2992
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isExclusive', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1208,
+ "module": "_models",
+ "name": "cron_expression",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2993
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='cronExpression', examples=['* * * * *'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1209,
+ "module": "_models",
+ "name": "timezone",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2994
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['UTC'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1210,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2995
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1211,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2996
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1212,
+ "module": "_models",
+ "name": "actions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2997
+ }
+ ],
+ "type": {
+ "name": "( list[Annotated[ScheduleCreateActionRunActor | ScheduleCreateActionRunActorTask, Field(discriminator='type')]] | None )",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ScheduleCreateActionRunActor",
+ "target": "1213"
+ },
+ {
+ "type": "reference",
+ "name": "ScheduleCreateActionRunActorTask",
+ "target": "1219"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1212,
+ 1208,
+ 1210,
+ 1206,
+ 1207,
+ 1204,
+ 1205,
+ 1209,
+ 1211
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1203,
+ "module": "_models",
+ "name": "ScheduleCreate",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2985
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1214,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3005
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1215,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3009
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1216,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3010
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1217,
+ "module": "_models",
+ "name": "run_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3011
+ }
+ ],
+ "type": {
+ "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ScheduleActionRunInput",
+ "target": "1170"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1218,
+ "module": "_models",
+ "name": "run_options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3012
+ }
+ ],
+ "type": {
+ "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskOptions",
+ "target": "1303"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1216,
+ 1214,
+ 1217,
+ 1218,
+ 1215
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1213,
+ "module": "_models",
+ "name": "ScheduleCreateActionRunActor",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3004
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1220,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3017
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1221,
+ "module": "_models",
+ "name": "type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3021
+ }
+ ],
+ "type": {
+ "name": "Literal",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "RUN_ACTOR_TASK"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1222,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3022
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1223,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3023
+ }
+ ],
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1222,
+ 1223,
+ 1220,
+ 1221
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1219,
+ "module": "_models",
+ "name": "ScheduleCreateActionRunActorTask",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3016
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1225,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3028
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1226,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3032
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1227,
+ "module": "_models",
+ "name": "level",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3033
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1228,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3034
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1228,
+ 1227,
+ 1226,
+ 1225
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1224,
+ "module": "_models",
+ "name": "ScheduleInvoked",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3027
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1230,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3039
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1231,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3043
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleInvoked",
+ "target": "1224"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1231,
+ 1230
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1229,
+ "module": "_models",
+ "name": "ScheduleLogResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3038
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1233,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3048
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1234,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3052
+ }
+ ],
+ "type": {
+ "name": "Schedule",
+ "type": "reference",
+ "target": "1197"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1234,
+ 1233
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1232,
+ "module": "_models",
+ "name": "ScheduleResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3047
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1236,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3057
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "overwrites": {
+ "name": "ScheduleBase.model_config",
+ "target": 1185,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1237,
+ "module": "_models",
+ "name": "actions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3061
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ScheduleActionShortRunActor",
+ "target": "1174"
+ },
+ {
+ "type": "reference",
+ "name": "ScheduleActionShortRunActorTask",
+ "target": "1179"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4134,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2956
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.id",
+ "target": 1186,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4135,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2957
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.user_id",
+ "target": 1187,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4136,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2958
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.name",
+ "target": 1188,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4137,
+ "module": "_models",
+ "name": "cron_expression",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2959
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.cron_expression",
+ "target": 1189,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4138,
+ "module": "_models",
+ "name": "timezone",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2960
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.timezone",
+ "target": 1190,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4139,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2961
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.is_enabled",
+ "target": 1191,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4140,
+ "module": "_models",
+ "name": "is_exclusive",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2962
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.is_exclusive",
+ "target": 1192,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4141,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2963
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.created_at",
+ "target": 1193,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4142,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2964
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.modified_at",
+ "target": 1194,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4143,
+ "module": "_models",
+ "name": "next_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2965
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.next_run_at",
+ "target": 1195,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4144,
+ "module": "_models",
+ "name": "last_run_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 2966
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "ScheduleBase.last_run_at",
+ "target": 1196,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1237,
+ 4141,
+ 4137,
+ 4134,
+ 4139,
+ 4140,
+ 4144,
+ 1236,
+ 4142,
+ 4136,
+ 4143,
+ 4138,
+ 4135
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1235,
+ "module": "_models",
+ "name": "ScheduleShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3056
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ScheduleBase",
+ "target": "1184",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1239,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3066
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of invalid items in the received array of items."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1240,
+ "module": "_models",
+ "name": "invalid_items",
+ "parsedDocstring": {
+ "text": "A list of invalid items in the received array of items."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3070
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "InvalidItem",
+ "target": "643"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1240,
+ 1239
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1238,
+ "module": "_models",
+ "name": "SchemaValidationErrorData",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3065
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1242,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3078
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1243,
+ "module": "_models",
+ "name": "format",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3082
+ }
+ ],
+ "type": {
+ "name": "SourceCodeFileFormat | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "SourceCodeFileFormat",
+ "target": "1898"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1244,
+ "module": "_models",
+ "name": "content",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3083
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=[\"console.log('This is the main.js file');\"])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1245,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3084
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1244,
+ 1243,
+ 1242,
+ 1245
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1241,
+ "module": "_models",
+ "name": "SourceCodeFile",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3077
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1247,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3094
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The folder path relative to the Actor's root directory."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1248,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": "The folder path relative to the Actor's root directory."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3098
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Always `true` for folders. Used to distinguish folders from files."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1249,
+ "module": "_models",
+ "name": "folder",
+ "parsedDocstring": {
+ "text": "Always `true` for folders. Used to distinguish folders from files."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3102
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1249,
+ 1247,
+ 1248
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1246,
+ "module": "_models",
+ "name": "SourceCodeFolder",
+ "parsedDocstring": {
+ "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3088
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1251,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3112
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased dataset IDs for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1252,
+ "module": "_models",
+ "name": "datasets",
+ "parsedDocstring": {
+ "text": "Aliased dataset IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3116
+ }
+ ],
+ "type": {
+ "name": "Datasets | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Datasets",
+ "target": "539"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased key-value store IDs for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1253,
+ "module": "_models",
+ "name": "key_value_stores",
+ "parsedDocstring": {
+ "text": "Aliased key-value store IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3120
+ }
+ ],
+ "type": {
+ "name": "Annotated[KeyValueStores | None, Field(alias='keyValueStores')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "KeyValueStores",
+ "target": "681"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Aliased request queue IDs for this run."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1254,
+ "module": "_models",
+ "name": "request_queues",
+ "parsedDocstring": {
+ "text": "Aliased request queue IDs for this run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3124
+ }
+ ],
+ "type": {
+ "name": "Annotated[RequestQueues | None, Field(alias='requestQueues')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestQueues",
+ "target": "1024"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A map of aliased storage IDs associated with this run, grouped by storage type."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1252,
+ 1253,
+ 1251,
+ 1254
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1250,
+ "module": "_models",
+ "name": "StorageIds",
+ "parsedDocstring": {
+ "text": "A map of aliased storage IDs associated with this run, grouped by storage type."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1256,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3132
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1257,
+ "module": "_models",
+ "name": "dataset",
+ "parsedDocstring": {
+ "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3136
+ }
+ ],
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1257,
+ 1256
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1255,
+ "module": "_models",
+ "name": "Storages",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3131
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1259,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3144
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1260,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3148
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1261,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3149
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1262,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3150
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1263,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3151
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1264,
+ "module": "_models",
+ "name": "user_full_name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3152
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1265,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3153
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1266,
+ "module": "_models",
+ "name": "categories",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3154
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[str] | None, Field(examples=[['MARKETING', 'LEAD_GENERATION']])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1267,
+ "module": "_models",
+ "name": "notice",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3155
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1268,
+ "module": "_models",
+ "name": "picture_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3156
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='pictureUrl', examples=['https://...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1269,
+ "module": "_models",
+ "name": "user_picture_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3157
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='userPictureUrl', examples=['https://...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1270,
+ "module": "_models",
+ "name": "url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3158
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(examples=['https://...'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1271,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3159
+ }
+ ],
+ "type": {
+ "name": "ActorStats",
+ "type": "reference",
+ "target": "285"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1272,
+ "module": "_models",
+ "name": "current_pricing_info",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3160
+ }
+ ],
+ "type": {
+ "name": "CurrentPricingInfo",
+ "type": "reference",
+ "target": "456"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is whitelisted for agentic payment processing."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1273,
+ "module": "_models",
+ "name": "is_white_listed_for_agentic_payments",
+ "parsedDocstring": {
+ "text": "Whether the Actor is whitelisted for agentic payment processing."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3161
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isWhiteListedForAgenticPayments')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1274,
+ "module": "_models",
+ "name": "actor_review_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3165
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='actorReviewCount', examples=[69])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1275,
+ "module": "_models",
+ "name": "actor_review_rating",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3166
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='actorReviewRating', examples=[4.7])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1276,
+ "module": "_models",
+ "name": "bookmark_count",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3167
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='bookmarkCount', examples=[1269])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1277,
+ "module": "_models",
+ "name": "badge",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3168
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=[None])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A brief, LLM-generated readme summary"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1278,
+ "module": "_models",
+ "name": "readme_summary",
+ "parsedDocstring": {
+ "text": "A brief, LLM-generated readme summary"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3169
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='readmeSummary')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1274,
+ 1275,
+ 1277,
+ 1276,
+ 1266,
+ 1272,
+ 1265,
+ 1260,
+ 1273,
+ 1259,
+ 1262,
+ 1267,
+ 1268,
+ 1278,
+ 1271,
+ 1261,
+ 1270,
+ 1264,
+ 1269,
+ 1263
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1258,
+ "module": "_models",
+ "name": "StoreListActor",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3143
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1280,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3179
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The ID of the build associated with this tag."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1281,
+ "module": "_models",
+ "name": "build_id",
+ "parsedDocstring": {
+ "text": "The ID of the build associated with this tag."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3183
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='buildId', examples=['z2EryhbfhgSyqj6Hn'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build number/version string."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1282,
+ "module": "_models",
+ "name": "build_number",
+ "parsedDocstring": {
+ "text": "The build number/version string."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3187
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field( alias='buildNumber', examples=['0.0.2'], pattern='^([0-9]|[1-9][0-9])\\\\.([0-9]|[1-9][0-9])(\\\\.[1-9][0-9]{0,4})$', ), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build number encoded as a single integer."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1283,
+ "module": "_models",
+ "name": "build_number_int",
+ "parsedDocstring": {
+ "text": "The build number encoded as a single integer."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3198
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='buildNumberInt', examples=[42])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timestamp when the build finished."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1284,
+ "module": "_models",
+ "name": "finished_at",
+ "parsedDocstring": {
+ "text": "The timestamp when the build finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3202
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-06-10T11:15:49.286Z'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Information about a tagged build."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1281,
+ 1282,
+ 1283,
+ 1284,
+ 1280
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1279,
+ "module": "_models",
+ "name": "TaggedBuildInfo",
+ "parsedDocstring": {
+ "text": "Information about a tagged build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3176
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1286,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3212
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1287,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3216
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1288,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3217
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1289,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3218
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1290,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3219
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1291,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3220
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['janedoe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1292,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3221
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1293,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3222
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1294,
+ "module": "_models",
+ "name": "removed_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3223
+ }
+ ],
+ "type": {
+ "name": "Annotated[AwareDatetime | None, Field(alias='removedAt')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AwareDatetime"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1295,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3224
+ }
+ ],
+ "type": {
+ "name": "TaskStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskStats",
+ "target": "1326"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1296,
+ "module": "_models",
+ "name": "options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3225
+ }
+ ],
+ "type": {
+ "name": "TaskOptions | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskOptions",
+ "target": "1303"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1297,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3226
+ }
+ ],
+ "type": {
+ "name": "TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1298,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3227
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1299,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3228
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1300,
+ "module": "_models",
+ "name": "standby_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3229
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='standbyUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1289,
+ 1299,
+ 1292,
+ 1287,
+ 1297,
+ 1286,
+ 1293,
+ 1290,
+ 1296,
+ 1294,
+ 1300,
+ 1295,
+ 1298,
+ 1288,
+ 1291
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1285,
+ "module": "_models",
+ "name": "Task",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3211
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1302,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3239
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1302
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1301,
+ "module": "_models",
+ "name": "TaskInput",
+ "parsedDocstring": {
+ "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3233
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1304,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3247
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1305,
+ "module": "_models",
+ "name": "build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3251
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['latest'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1306,
+ "module": "_models",
+ "name": "timeout_secs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3252
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[300])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1307,
+ "module": "_models",
+ "name": "memory_mbytes",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3253
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1308,
+ "module": "_models",
+ "name": "max_items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3254
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1309,
+ "module": "_models",
+ "name": "max_total_charge_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3255
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1310,
+ "module": "_models",
+ "name": "restart_on_error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3256
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1305,
+ 1308,
+ 1309,
+ 1307,
+ 1304,
+ 1310,
+ 1306
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1303,
+ "module": "_models",
+ "name": "TaskOptions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3246
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1312,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3263
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1313,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3267
+ }
+ ],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing Actor task data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1313,
+ 1312
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1311,
+ "module": "_models",
+ "name": "TaskResponse",
+ "parsedDocstring": {
+ "text": "Response containing Actor task data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3260
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1315,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3272
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1316,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3276
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1317,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3277
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1318,
+ "module": "_models",
+ "name": "act_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3278
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1319,
+ "module": "_models",
+ "name": "act_name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3279
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actName', examples=['my-actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1320,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3280
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1321,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3281
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['janedoe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1322,
+ "module": "_models",
+ "name": "act_username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3282
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actUsername', examples=['janedoe'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1323,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3283
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1324,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3284
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1325,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3285
+ }
+ ],
+ "type": {
+ "name": "TaskStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskStats",
+ "target": "1326"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1318,
+ 1319,
+ 1322,
+ 1323,
+ 1316,
+ 1315,
+ 1324,
+ 1320,
+ 1325,
+ 1317,
+ 1321
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1314,
+ "module": "_models",
+ "name": "TaskShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3271
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1327,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3290
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1328,
+ "module": "_models",
+ "name": "total_runs",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3294
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='totalRuns', examples=[15])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1327,
+ 1328
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1326,
+ "module": "_models",
+ "name": "TaskStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3289
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1330,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3299
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1331,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3303
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch",
+ "type": "reference",
+ "target": "1474"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1331,
+ 1330
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1329,
+ "module": "_models",
+ "name": "TestWebhookResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3298
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "WebhookDispatchResponse",
+ "target": "1485",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1333,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3310
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Price per unit in USD for this tier."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1334,
+ "module": "_models",
+ "name": "tiered_price_per_unit_usd",
+ "parsedDocstring": {
+ "text": "Price per unit in USD for this tier."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3314
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A single tier's price-per-dataset-item entry."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1333,
+ 1334
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1332,
+ "module": "_models",
+ "name": "TieredPricingPerDatasetItemEntry",
+ "parsedDocstring": {
+ "text": "A single tier's price-per-dataset-item entry."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3307
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1336,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3324
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Price per event in USD for this tier."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1337,
+ "module": "_models",
+ "name": "tiered_event_price_usd",
+ "parsedDocstring": {
+ "text": "Price per event in USD for this tier."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3328
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A single tier's price-per-event entry."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1336,
+ 1337
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1335,
+ "module": "_models",
+ "name": "TieredPricingPerEventEntry",
+ "parsedDocstring": {
+ "text": "A single tier's price-per-event entry."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3321
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1339,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3338
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1340,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3342
+ }
+ ],
+ "type": {
+ "name": "UnlockRequestsResult",
+ "type": "reference",
+ "target": "1341"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing the result of unlocking requests."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1340,
+ 1339
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1338,
+ "module": "_models",
+ "name": "UnlockRequestsResponse",
+ "parsedDocstring": {
+ "text": "Response containing the result of unlocking requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3335
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1342,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3349
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of requests that were successfully unlocked."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1343,
+ "module": "_models",
+ "name": "unlocked_count",
+ "parsedDocstring": {
+ "text": "Number of requests that were successfully unlocked."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3353
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Result of unlocking requests in the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1342,
+ 1343
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1341,
+ "module": "_models",
+ "name": "UnlockRequestsResult",
+ "parsedDocstring": {
+ "text": "Result of unlocking requests in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3346
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1345,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3361
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1346,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3365
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['MyActor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1347,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3366
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1348,
+ "module": "_models",
+ "name": "is_public",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3367
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1349,
+ "module": "_models",
+ "name": "actor_permission_level",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3368
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1350,
+ "module": "_models",
+ "name": "seo_title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3369
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1351,
+ "module": "_models",
+ "name": "seo_description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3370
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1352,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3371
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['My Actor'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1353,
+ "module": "_models",
+ "name": "restart_on_error",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3372
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1354,
+ "module": "_models",
+ "name": "versions",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3373
+ }
+ ],
+ "type": {
+ "name": "list[CreateOrUpdateVersionRequest] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "CreateOrUpdateVersionRequest",
+ "target": "424"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1355,
+ "module": "_models",
+ "name": "pricing_infos",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3374
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "PayPerEventActorPricingInfo",
+ "target": "848"
+ },
+ {
+ "type": "reference",
+ "name": "PricePerDatasetItemActorPricingInfo",
+ "target": "880"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FlatPricePerMonthActorPricingInfo",
+ "target": "622"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "FreeActorPricingInfo",
+ "target": "627"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1356,
+ "module": "_models",
+ "name": "categories",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3387
+ }
+ ],
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1357,
+ "module": "_models",
+ "name": "default_run_options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3388
+ }
+ ],
+ "type": {
+ "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "DefaultRunOptions",
+ "target": "550"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```"
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1358,
+ "module": "_models",
+ "name": "tagged_builds",
+ "parsedDocstring": {
+ "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3389
+ }
+ ],
+ "type": {
+ "name": "Annotated[ dict[str, Any] | None, Field(alias='taggedBuilds', examples=[{'latest': {'buildId': 'z2EryhbfhgSyqj6Hn'}, 'beta': None}]), ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1359,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3434
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1360,
+ "module": "_models",
+ "name": "example_run_input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3435
+ }
+ ],
+ "type": {
+ "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ExampleRunInput",
+ "target": "613"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1361,
+ "module": "_models",
+ "name": "is_deprecated",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3436
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isDeprecated')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1349,
+ 1359,
+ 1356,
+ 1357,
+ 1347,
+ 1360,
+ 1361,
+ 1348,
+ 1345,
+ 1346,
+ 1355,
+ 1353,
+ 1351,
+ 1350,
+ 1358,
+ 1352,
+ 1354
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1344,
+ "module": "_models",
+ "name": "UpdateActorRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3360
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1363,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3441
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1364,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3445
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1365,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3446
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1365,
+ 1363,
+ 1364
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1362,
+ "module": "_models",
+ "name": "UpdateDatasetRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3440
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "UpdateStoreRequest",
+ "target": "1383",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1367,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3451
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1368,
+ "module": "_models",
+ "name": "max_monthly_usage_usd",
+ "parsedDocstring": {
+ "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3455
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='maxMonthlyUsageUsd', examples=[300])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1369,
+ "module": "_models",
+ "name": "data_retention_days",
+ "parsedDocstring": {
+ "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3460
+ }
+ ],
+ "type": {
+ "name": "Annotated[int | None, Field(alias='dataRetentionDays', examples=[90])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1369,
+ 1368,
+ 1367
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1366,
+ "module": "_models",
+ "name": "UpdateLimitsRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3450
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1371,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3471
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for the request queue."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1372,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": "The new name for the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3475
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1373,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3479
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Request object for updating a request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1373,
+ 1371,
+ 1372
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1370,
+ "module": "_models",
+ "name": "UpdateRequestQueueRequest",
+ "parsedDocstring": {
+ "text": "Request object for updating a request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3468
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1375,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3486
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1376,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3490
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing the result of updating a request in the request queue."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1376,
+ 1375
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1374,
+ "module": "_models",
+ "name": "UpdateRequestResponse",
+ "parsedDocstring": {
+ "text": "Response containing the result of updating a request in the request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3483
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1378,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3495
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1379,
+ "module": "_models",
+ "name": "run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3499
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='runId', examples=['3KH8gEpp4d8uQSe8T'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1380,
+ "module": "_models",
+ "name": "status_message",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3500
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor has finished'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1381,
+ "module": "_models",
+ "name": "is_status_message_terminal",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3501
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1382,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3502
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1382,
+ 1381,
+ 1378,
+ 1379,
+ 1380
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1377,
+ "module": "_models",
+ "name": "UpdateRunRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3494
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4120,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3441
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "UpdateDatasetRequest.model_config",
+ "target": 1363,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4121,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3445
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "UpdateDatasetRequest.name",
+ "target": 1364,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4122,
+ "module": "_models",
+ "name": "general_access",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3446
+ }
+ ],
+ "type": {
+ "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ "inheritedFrom": {
+ "name": "UpdateDatasetRequest.general_access",
+ "target": 1365,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4122,
+ 4120,
+ 4121
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1383,
+ "module": "_models",
+ "name": "UpdateStoreRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3506
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "UpdateDatasetRequest",
+ "target": "1362",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1385,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3512
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1386,
+ "module": "_models",
+ "name": "name",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3516
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['my-task'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1387,
+ "module": "_models",
+ "name": "options",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3517
+ }
+ ],
+ "type": {
+ "name": "TaskOptions | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskOptions",
+ "target": "1303"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1388,
+ "module": "_models",
+ "name": "input",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3518
+ }
+ ],
+ "type": {
+ "name": "TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1389,
+ "module": "_models",
+ "name": "title",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3519
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1390,
+ "module": "_models",
+ "name": "actor_standby",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3520
+ }
+ ],
+ "type": {
+ "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorStandby",
+ "target": "275"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1390,
+ 1388,
+ 1385,
+ 1386,
+ 1387,
+ 1389
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1384,
+ "module": "_models",
+ "name": "UpdateTaskRequest",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3511
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1392,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3525
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1393,
+ "module": "_models",
+ "name": "start_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3529
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1394,
+ "module": "_models",
+ "name": "end_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3530
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1394,
+ 1392,
+ 1393
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1391,
+ "module": "_models",
+ "name": "UsageCycle",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3524
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1396,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3535
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1397,
+ "module": "_models",
+ "name": "quantity",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3539
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1398,
+ "module": "_models",
+ "name": "base_amount_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3540
+ }
+ ],
+ "type": {
+ "name": "float",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1399,
+ "module": "_models",
+ "name": "base_unit_price_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3541
+ }
+ ],
+ "type": {
+ "name": "Annotated[float | None, Field(alias='baseUnitPriceUsd', examples=[0.25])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1400,
+ "module": "_models",
+ "name": "amount_after_volume_discount_usd",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3542
+ }
+ ],
+ "type": {
+ "name": "Annotated[ float | None, Field(alias='amountAfterVolumeDiscountUsd', examples=[0.69611875]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1401,
+ "module": "_models",
+ "name": "price_tiers",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3545
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[PriceTiers] | None, Field(alias='priceTiers')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "PriceTiers",
+ "target": "886"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1400,
+ 1398,
+ 1399,
+ 1396,
+ 1401,
+ 1397
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1395,
+ "module": "_models",
+ "name": "UsageItem",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3534
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1403,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3550
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1404,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3554
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1405,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3555
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1406,
+ "module": "_models",
+ "name": "profile",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3556
+ }
+ ],
+ "type": {
+ "name": "Profile",
+ "type": "reference",
+ "target": "899"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1407,
+ "module": "_models",
+ "name": "email",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3557
+ }
+ ],
+ "type": {
+ "name": "EmailStr",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1408,
+ "module": "_models",
+ "name": "proxy",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3558
+ }
+ ],
+ "type": {
+ "name": "Proxy",
+ "type": "reference",
+ "target": "910"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1409,
+ "module": "_models",
+ "name": "plan",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3559
+ }
+ ],
+ "type": {
+ "name": "Plan",
+ "type": "reference",
+ "target": "853"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1410,
+ "module": "_models",
+ "name": "effective_platform_features",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3560
+ }
+ ],
+ "type": {
+ "name": "EffectivePlatformFeatures",
+ "type": "reference",
+ "target": "573"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1411,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3561
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1412,
+ "module": "_models",
+ "name": "is_paying",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3562
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1411,
+ 1410,
+ 1407,
+ 1404,
+ 1412,
+ 1403,
+ 1409,
+ 1406,
+ 1408,
+ 1405
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1402,
+ "module": "_models",
+ "name": "UserPrivateInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3549
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1414,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3567
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1415,
+ "module": "_models",
+ "name": "username",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3571
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1416,
+ "module": "_models",
+ "name": "profile",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3572
+ }
+ ],
+ "type": {
+ "name": "Profile | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Profile",
+ "target": "899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1414,
+ 1416,
+ 1415
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1413,
+ "module": "_models",
+ "name": "UserPublicInfo",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3566
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1418,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3577
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the instance being validated."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1419,
+ "module": "_models",
+ "name": "instance_path",
+ "parsedDocstring": {
+ "text": "The path to the instance being validated."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3581
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='instancePath')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The path to the schema that failed the validation."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1420,
+ "module": "_models",
+ "name": "schema_path",
+ "parsedDocstring": {
+ "text": "The path to the schema that failed the validation."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3585
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='schemaPath')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The validation keyword that caused the error."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1421,
+ "module": "_models",
+ "name": "keyword",
+ "parsedDocstring": {
+ "text": "The validation keyword that caused the error."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3589
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A message describing the validation error."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1422,
+ "module": "_models",
+ "name": "message",
+ "parsedDocstring": {
+ "text": "A message describing the validation error."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3593
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional parameters specific to the validation error."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1423,
+ "module": "_models",
+ "name": "params",
+ "parsedDocstring": {
+ "text": "Additional parameters specific to the validation error."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3597
+ }
+ ],
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1419,
+ 1421,
+ 1422,
+ 1418,
+ 1423,
+ 1420
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1417,
+ "module": "_models",
+ "name": "ValidationError",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3576
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1425,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3605
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1426,
+ "module": "_models",
+ "name": "version_number",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3609
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1427,
+ "module": "_models",
+ "name": "source_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3612
+ }
+ ],
+ "type": {
+ "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "VersionSourceType",
+ "target": "1900"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1428,
+ "module": "_models",
+ "name": "env_vars",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3613
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[EnvVar] | None, Field(alias='envVars')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1429,
+ "module": "_models",
+ "name": "apply_env_vars_to_build",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3614
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1430,
+ "module": "_models",
+ "name": "build_tag",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3615
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1431,
+ "module": "_models",
+ "name": "source_files",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3616
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "SourceCodeFile",
+ "target": "1241"
+ },
+ {
+ "type": "reference",
+ "name": "SourceCodeFolder",
+ "target": "1246"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the Git repository when sourceType is GIT_REPO."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1432,
+ "module": "_models",
+ "name": "git_repo_url",
+ "parsedDocstring": {
+ "text": "URL of the Git repository when sourceType is GIT_REPO."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3619
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='gitRepoUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the tarball when sourceType is TARBALL."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1433,
+ "module": "_models",
+ "name": "tarball_url",
+ "parsedDocstring": {
+ "text": "URL of the tarball when sourceType is TARBALL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3623
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='tarballUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1434,
+ "module": "_models",
+ "name": "github_gist_url",
+ "parsedDocstring": {
+ "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3627
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1429,
+ 1430,
+ 1428,
+ 1432,
+ 1434,
+ 1425,
+ 1431,
+ 1427,
+ 1433,
+ 1426
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1424,
+ "module": "_models",
+ "name": "Version",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3604
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1436,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3635
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1437,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3639
+ }
+ ],
+ "type": {
+ "name": "Version",
+ "type": "reference",
+ "target": "1424"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1437,
+ 1436
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1435,
+ "module": "_models",
+ "name": "VersionResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3634
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1439,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3644
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1440,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3648
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1441,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3649
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1442,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3650
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1443,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3651
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1444,
+ "module": "_models",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3652
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1445,
+ "module": "_models",
+ "name": "should_interpolate_strings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3653
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1446,
+ "module": "_models",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3654
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1447,
+ "module": "_models",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3655
+ }
+ ],
+ "type": {
+ "name": "WebhookCondition",
+ "type": "reference",
+ "target": "1456"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1448,
+ "module": "_models",
+ "name": "ignore_ssl_errors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3656
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1449,
+ "module": "_models",
+ "name": "do_not_retry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3657
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1450,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3658
+ }
+ ],
+ "type": {
+ "name": "AnyUrl",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1451,
+ "module": "_models",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3659
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1452,
+ "module": "_models",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3662
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1453,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3665
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['this is webhook description'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1454,
+ "module": "_models",
+ "name": "last_dispatch",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3666
+ }
+ ],
+ "type": {
+ "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ExampleWebhookDispatch",
+ "target": "617"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1455,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3667
+ }
+ ],
+ "type": {
+ "name": "WebhookStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookStats",
+ "target": "1519"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1447,
+ 1441,
+ 1453,
+ 1449,
+ 1446,
+ 1452,
+ 1440,
+ 1448,
+ 1444,
+ 1454,
+ 1439,
+ 1442,
+ 1451,
+ 1450,
+ 1445,
+ 1455,
+ 1443
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1438,
+ "module": "_models",
+ "name": "Webhook",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3643
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1457,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3672
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1458,
+ "module": "_models",
+ "name": "actor_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3676
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actorId', examples=['hksJZtadYvn4mBuin'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1459,
+ "module": "_models",
+ "name": "actor_task_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3677
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['asdLZtadYvn4mBZmm'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1460,
+ "module": "_models",
+ "name": "actor_run_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3678
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actorRunId', examples=['hgdKZtadYvn4mBpoi'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1458,
+ 1460,
+ 1459,
+ 1457
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1456,
+ "module": "_models",
+ "name": "WebhookCondition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3671
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1462,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3683
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1463,
+ "module": "_models",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3687
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1464,
+ "module": "_models",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3688
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1465,
+ "module": "_models",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3689
+ }
+ ],
+ "type": {
+ "name": "WebhookCondition",
+ "type": "reference",
+ "target": "1456"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1466,
+ "module": "_models",
+ "name": "idempotency_key",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3690
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='idempotencyKey', examples=['fdSJmdP3nfs7sfk3y'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1467,
+ "module": "_models",
+ "name": "ignore_ssl_errors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3691
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1468,
+ "module": "_models",
+ "name": "do_not_retry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3692
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1469,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3693
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1470,
+ "module": "_models",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3694
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1471,
+ "module": "_models",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3697
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1472,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3700
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['this is webhook description'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1473,
+ "module": "_models",
+ "name": "should_interpolate_strings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3701
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1465,
+ 1472,
+ 1468,
+ 1464,
+ 1471,
+ 1466,
+ 1467,
+ 1463,
+ 1462,
+ 1470,
+ 1469,
+ 1473
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1461,
+ "module": "_models",
+ "name": "WebhookCreate",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3682
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1475,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3706
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1476,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3710
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1477,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3711
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1478,
+ "module": "_models",
+ "name": "webhook_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3712
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1479,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3713
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1480,
+ "module": "_models",
+ "name": "status",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3714
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatchStatus",
+ "type": "reference",
+ "target": "1901"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1481,
+ "module": "_models",
+ "name": "event_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3715
+ }
+ ],
+ "type": {
+ "name": "WebhookEventType",
+ "type": "reference",
+ "target": "1902"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1482,
+ "module": "_models",
+ "name": "event_data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3716
+ }
+ ],
+ "type": {
+ "name": "Annotated[EventData | None, Field(alias='eventData', title='eventData')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "EventData",
+ "target": "609"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1483,
+ "module": "_models",
+ "name": "webhook",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3717
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatchWebhookSummary | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatchWebhookSummary",
+ "target": "1486"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1484,
+ "module": "_models",
+ "name": "calls",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3718
+ }
+ ],
+ "type": {
+ "name": "Annotated[list[Call] | None, Field(title='calls')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Call",
+ "target": "387"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1484,
+ 1479,
+ 1482,
+ 1481,
+ 1476,
+ 1475,
+ 1480,
+ 1477,
+ 1483,
+ 1478
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1474,
+ "module": "_models",
+ "name": "WebhookDispatch",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3705
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4118,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3299
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "TestWebhookResponse.model_config",
+ "target": 1330,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 4119,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3303
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch",
+ "type": "reference",
+ "target": "1474"
+ },
+ "inheritedFrom": {
+ "name": "TestWebhookResponse.data",
+ "target": 1331,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4119,
+ 4118
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1485,
+ "module": "_models",
+ "name": "WebhookDispatchResponse",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3722
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "TestWebhookResponse",
+ "target": "1329",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1487,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3730
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1488,
+ "module": "_models",
+ "name": "action_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3734
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actionType', examples=['HTTP_REQUEST'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1489,
+ "module": "_models",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3735
+ }
+ ],
+ "type": {
+ "name": "WebhookCondition | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookCondition",
+ "target": "1456"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1490,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3736
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='requestUrl', examples=['https://example.com/webhook'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1491,
+ "module": "_models",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3737
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A summary of the webhook that triggered this dispatch."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1488,
+ 1489,
+ 1491,
+ 1487,
+ 1490
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1486,
+ "module": "_models",
+ "name": "WebhookDispatchWebhookSummary",
+ "parsedDocstring": {
+ "text": "A summary of the webhook that triggered this dispatch."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3727
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1493,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3748
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1494,
+ "module": "_models",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3752
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL to which the webhook sends its payload."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1495,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": "The URL to which the webhook sends its payload."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3753
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the JSON payload sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1496,
+ "module": "_models",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": "Optional template for the JSON payload sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3757
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1497,
+ "module": "_models",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": "Optional template for the HTTP headers sent by the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3763
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1494,
+ 1497,
+ 1493,
+ 1496,
+ 1495
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1492,
+ "module": "_models",
+ "name": "WebhookRepresentation",
+ "parsedDocstring": {
+ "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3741
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1499,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3775
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1500,
+ "module": "_models",
+ "name": "data",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3779
+ }
+ ],
+ "type": {
+ "name": "Webhook",
+ "type": "reference",
+ "target": "1438"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response containing webhook data."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1500,
+ 1499
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1498,
+ "module": "_models",
+ "name": "WebhookResponse",
+ "parsedDocstring": {
+ "text": "Response containing webhook data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3772
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1502,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3784
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1503,
+ "module": "_models",
+ "name": "id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3788
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1504,
+ "module": "_models",
+ "name": "created_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3789
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1505,
+ "module": "_models",
+ "name": "modified_at",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3790
+ }
+ ],
+ "type": {
+ "name": "AwareDatetime",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1506,
+ "module": "_models",
+ "name": "user_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3791
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1507,
+ "module": "_models",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3792
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1508,
+ "module": "_models",
+ "name": "is_apify_integration",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3793
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isApifyIntegration', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1509,
+ "module": "_models",
+ "name": "is_enabled",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3794
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isEnabled', examples=[True])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1510,
+ "module": "_models",
+ "name": "action_type",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3795
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(alias='actionType', examples=['HTTP_REQUEST'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1511,
+ "module": "_models",
+ "name": "should_interpolate_strings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3796
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1512,
+ "module": "_models",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3797
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1513,
+ "module": "_models",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3798
+ }
+ ],
+ "type": {
+ "name": "WebhookCondition",
+ "type": "reference",
+ "target": "1456"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1514,
+ "module": "_models",
+ "name": "ignore_ssl_errors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3799
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1515,
+ "module": "_models",
+ "name": "do_not_retry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3800
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1516,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3801
+ }
+ ],
+ "type": {
+ "name": "AnyUrl",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1517,
+ "module": "_models",
+ "name": "last_dispatch",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3802
+ }
+ ],
+ "type": {
+ "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ExampleWebhookDispatch",
+ "target": "617"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1518,
+ "module": "_models",
+ "name": "stats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3803
+ }
+ ],
+ "type": {
+ "name": "WebhookStats | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookStats",
+ "target": "1519"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1510,
+ 1513,
+ 1504,
+ 1515,
+ 1512,
+ 1503,
+ 1514,
+ 1507,
+ 1508,
+ 1509,
+ 1517,
+ 1502,
+ 1505,
+ 1516,
+ 1511,
+ 1518,
+ 1506
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1501,
+ "module": "_models",
+ "name": "WebhookShort",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3783
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1520,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3808
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1521,
+ "module": "_models",
+ "name": "total_dispatches",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3812
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1520,
+ 1521
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1519,
+ "module": "_models",
+ "name": "WebhookStats",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3807
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1523,
+ "module": "_models",
+ "name": "model_config",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3817
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1524,
+ "module": "_models",
+ "name": "is_ad_hoc",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3821
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1525,
+ "module": "_models",
+ "name": "event_types",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3822
+ }
+ ],
+ "type": {
+ "name": "Annotated[ list[WebhookEventType] | None, Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']]) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1526,
+ "module": "_models",
+ "name": "condition",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3825
+ }
+ ],
+ "type": {
+ "name": "WebhookCondition | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookCondition",
+ "target": "1456"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1527,
+ "module": "_models",
+ "name": "ignore_ssl_errors",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3826
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1528,
+ "module": "_models",
+ "name": "do_not_retry",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3827
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1529,
+ "module": "_models",
+ "name": "request_url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3828
+ }
+ ],
+ "type": {
+ "name": "Annotated[AnyUrl | None, Field(alias='requestUrl', examples=['http://example.com/'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AnyUrl"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1530,
+ "module": "_models",
+ "name": "payload_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3829
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1531,
+ "module": "_models",
+ "name": "headers_template",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3832
+ }
+ ],
+ "type": {
+ "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1532,
+ "module": "_models",
+ "name": "description",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3835
+ }
+ ],
+ "type": {
+ "name": "Annotated[str | None, Field(examples=['this is webhook description'])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1533,
+ "module": "_models",
+ "name": "should_interpolate_strings",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3836
+ }
+ ],
+ "type": {
+ "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Models')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1526,
+ 1532,
+ 1528,
+ 1525,
+ 1531,
+ 1527,
+ 1524,
+ 1523,
+ 1530,
+ 1529,
+ 1533
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1522,
+ "module": "_models",
+ "name": "WebhookUpdate",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_models.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 3816
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1535,
+ "module": "_apify_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n",
+ "args": {
+ "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.",
+ "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.",
+ "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.",
+ "max_retries": "How many times to retry a failed request at most.",
+ "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "headers": "Additional HTTP headers to include in all API requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 112
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1536,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 1537,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1538,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1539,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_public_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many times to retry a failed request at most."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1540,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1541,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1542,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1543,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1544,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1545,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all API requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1546,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "classmethod"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1547,
+ "module": "_apify_client",
+ "name": "with_custom_http_client",
+ "parsedDocstring": {
+ "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```",
+ "args": {
+ "token": "The Apify API token.",
+ "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.",
+ "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.",
+ "http_client": "A custom HTTP client instance extending `HttpClient`."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 210
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1548,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "with_custom_http_client",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 1549,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1550,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1551,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_public_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A custom HTTP client instance extending `HttpClient`."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1552,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ }
+ ],
+ "type": {
+ "name": "ApifyClient",
+ "type": "reference",
+ "target": "1534"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token used by the client."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1553,
+ "module": "_apify_client",
+ "name": "token",
+ "parsedDocstring": {
+ "text": "The Apify API token used by the client."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 251
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1554,
+ "module": "_apify_client",
+ "name": "http_client",
+ "parsedDocstring": {
+ "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 256
+ }
+ ],
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1555,
+ "module": "_apify_client",
+ "name": "actor",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor.\n",
+ "args": {
+ "actor_id": "ID of the Actor to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 287
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1556,
+ "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": 1557,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorClient",
+ "type": "reference",
+ "target": "3502"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1558,
+ "module": "_apify_client",
+ "name": "actors",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 295
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1559,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "actors",
+ "parameters": [],
+ "type": {
+ "name": "ActorCollectionClient",
+ "type": "reference",
+ "target": "2360"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor build.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1560,
+ "module": "_apify_client",
+ "name": "build",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor build.\n",
+ "args": {
+ "build_id": "ID of the Actor build to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 299
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor build.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1561,
+ "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": 1562,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "BuildClient",
+ "type": "reference",
+ "target": "3269"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1563,
+ "module": "_apify_client",
+ "name": "builds",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 307
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1564,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "builds",
+ "parameters": [],
+ "type": {
+ "name": "BuildCollectionClient",
+ "type": "reference",
+ "target": "2876"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor run.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1565,
+ "module": "_apify_client",
+ "name": "run",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor run.\n",
+ "args": {
+ "run_id": "ID of the Actor run to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 311
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor run.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1566,
+ "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": 1567,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClient",
+ "type": "reference",
+ "target": "3131"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1568,
+ "module": "_apify_client",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 319
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1569,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClient",
+ "type": "reference",
+ "target": "4014"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific dataset.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1570,
+ "module": "_apify_client",
+ "name": "dataset",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific dataset.\n",
+ "args": {
+ "dataset_id": "ID of the dataset to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 323
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific dataset.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1571,
+ "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": 1572,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "dataset_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetClient",
+ "type": "reference",
+ "target": "2917"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1573,
+ "module": "_apify_client",
+ "name": "datasets",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 331
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1574,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "datasets",
+ "parameters": [],
+ "type": {
+ "name": "DatasetCollectionClient",
+ "type": "reference",
+ "target": "3419"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific key-value store.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1575,
+ "module": "_apify_client",
+ "name": "key_value_store",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific key-value store.\n",
+ "args": {
+ "key_value_store_id": "ID of the key-value store to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 335
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific key-value store.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1576,
+ "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": 1577,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key_value_store_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStoreClient",
+ "type": "reference",
+ "target": "3706"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1578,
+ "module": "_apify_client",
+ "name": "key_value_stores",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 343
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1579,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "key_value_stores",
+ "parameters": [],
+ "type": {
+ "name": "KeyValueStoreCollectionClient",
+ "type": "reference",
+ "target": "2470"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific request queue.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1580,
+ "module": "_apify_client",
+ "name": "request_queue",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific request queue.\n",
+ "args": {
+ "request_queue_id": "ID of the request queue to be manipulated.",
+ "client_key": "A unique identifier of the client accessing the request queue."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 347
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific request queue.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1581,
+ "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": 1582,
+ "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": 1583,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueueClient",
+ "type": "reference",
+ "target": "2094"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1584,
+ "module": "_apify_client",
+ "name": "request_queues",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 356
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1585,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "request_queues",
+ "parameters": [],
+ "type": {
+ "name": "RequestQueueCollectionClient",
+ "type": "reference",
+ "target": "2578"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1586,
+ "module": "_apify_client",
+ "name": "webhook",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific webhook.\n",
+ "args": {
+ "webhook_id": "ID of the webhook to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 360
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1587,
+ "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": 1588,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhook_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookClient",
+ "type": "reference",
+ "target": "3954"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1589,
+ "module": "_apify_client",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 368
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1590,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClient",
+ "type": "reference",
+ "target": "3892"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook dispatch.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1591,
+ "module": "_apify_client",
+ "name": "webhook_dispatch",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific webhook dispatch.\n",
+ "args": {
+ "webhook_dispatch_id": "ID of the webhook dispatch to access."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 372
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook dispatch.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1592,
+ "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": 1593,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhook_dispatch_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatchClient",
+ "type": "reference",
+ "target": "2452"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1594,
+ "module": "_apify_client",
+ "name": "webhook_dispatches",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 380
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1595,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhook_dispatches",
+ "parameters": [],
+ "type": {
+ "name": "WebhookDispatchCollectionClient",
+ "type": "reference",
+ "target": "2326"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific schedule.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1596,
+ "module": "_apify_client",
+ "name": "schedule",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific schedule.\n",
+ "args": {
+ "schedule_id": "ID of the schedule to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 384
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific schedule.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1597,
+ "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": 1598,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schedule_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ScheduleClient",
+ "type": "reference",
+ "target": "2002"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1599,
+ "module": "_apify_client",
+ "name": "schedules",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 392
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1600,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "schedules",
+ "parameters": [],
+ "type": {
+ "name": "ScheduleCollectionClient",
+ "type": "reference",
+ "target": "3317"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1601,
+ "module": "_apify_client",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n",
+ "args": {
+ "build_or_run_id": "ID of the Actor build or run for which to access the log."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 396
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1602,
+ "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": 1603,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_or_run_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "LogClient",
+ "type": "reference",
+ "target": "2258"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor task.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1604,
+ "module": "_apify_client",
+ "name": "task",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor task.\n",
+ "args": {
+ "task_id": "ID of the task to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 404
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor task.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1605,
+ "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": 1606,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "TaskClient",
+ "type": "reference",
+ "target": "2746"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1607,
+ "module": "_apify_client",
+ "name": "tasks",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 412
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1608,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "tasks",
+ "parameters": [],
+ "type": {
+ "name": "TaskCollectionClient",
+ "type": "reference",
+ "target": "2628"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for querying user data.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1609,
+ "module": "_apify_client",
+ "name": "user",
+ "parsedDocstring": {
+ "text": "Get the sub-client for querying user data.\n",
+ "args": {
+ "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 416
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for querying user data.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1610,
+ "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": 1611,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "user_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "UserClient",
+ "type": "reference",
+ "target": "2054"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1612,
+ "module": "_apify_client",
+ "name": "store",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 424
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1613,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "store",
+ "parameters": [],
+ "type": {
+ "name": "StoreCollectionClient",
+ "type": "reference",
+ "target": "2696"
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Apify API clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1535,
+ 1555,
+ 1558,
+ 1560,
+ 1563,
+ 1570,
+ 1573,
+ 1575,
+ 1578,
+ 1601,
+ 1580,
+ 1584,
+ 1565,
+ 1568,
+ 1596,
+ 1599,
+ 1612,
+ 1604,
+ 1607,
+ 1609,
+ 1586,
+ 1591,
+ 1594,
+ 1589,
+ 1547
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 1554,
+ 1553
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1534,
+ "module": "_apify_client",
+ "name": "ApifyClient",
+ "parsedDocstring": {
+ "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 83
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1615,
+ "module": "_apify_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n",
+ "args": {
+ "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.",
+ "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.",
+ "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.",
+ "max_retries": "How many times to retry a failed request at most.",
+ "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "headers": "Additional HTTP headers to include in all API requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 466
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1616,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 1617,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1618,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1619,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_public_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many times to retry a failed request at most."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1620,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1621,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1622,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1623,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1624,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1625,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all API requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1626,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "classmethod"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1627,
+ "module": "_apify_client",
+ "name": "with_custom_http_client",
+ "parsedDocstring": {
+ "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```",
+ "args": {
+ "token": "The Apify API token.",
+ "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.",
+ "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.",
+ "http_client": "A custom HTTP client instance extending `HttpClientAsync`."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 564
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1628,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "with_custom_http_client",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 1629,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1630,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_API_URL",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1631,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "api_public_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A custom HTTP client instance extending `HttpClientAsync`."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1632,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ }
+ ],
+ "type": {
+ "name": "ApifyClientAsync",
+ "type": "reference",
+ "target": "1614"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Apify API token used by the client."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1633,
+ "module": "_apify_client",
+ "name": "token",
+ "parsedDocstring": {
+ "text": "The Apify API token used by the client."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 605
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1634,
+ "module": "_apify_client",
+ "name": "http_client",
+ "parsedDocstring": {
+ "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 610
+ }
+ ],
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1635,
+ "module": "_apify_client",
+ "name": "actor",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor.\n",
+ "args": {
+ "actor_id": "ID of the Actor to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 640
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1636,
+ "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": 1637,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorClientAsync",
+ "type": "reference",
+ "target": "3604"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1638,
+ "module": "_apify_client",
+ "name": "actors",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 648
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Actor collection, allowing to list and create Actors."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1639,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "actors",
+ "parameters": [],
+ "type": {
+ "name": "ActorCollectionClientAsync",
+ "type": "reference",
+ "target": "2406"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor build.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1640,
+ "module": "_apify_client",
+ "name": "build",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor build.\n",
+ "args": {
+ "build_id": "ID of the Actor build to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 652
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor build.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1641,
+ "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": 1642,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "BuildClientAsync",
+ "type": "reference",
+ "target": "3293"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1643,
+ "module": "_apify_client",
+ "name": "builds",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 660
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the build collection, allowing to list builds."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1644,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "builds",
+ "parameters": [],
+ "type": {
+ "name": "BuildCollectionClientAsync",
+ "type": "reference",
+ "target": "2893"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor run.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1645,
+ "module": "_apify_client",
+ "name": "run",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor run.\n",
+ "args": {
+ "run_id": "ID of the Actor run to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 664
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor run.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1646,
+ "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": 1647,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClientAsync",
+ "type": "reference",
+ "target": "3200"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1648,
+ "module": "_apify_client",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 672
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the run collection, allowing to list Actor runs."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1649,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClientAsync",
+ "type": "reference",
+ "target": "4037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific dataset.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1650,
+ "module": "_apify_client",
+ "name": "dataset",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific dataset.\n",
+ "args": {
+ "dataset_id": "ID of the dataset to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 676
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific dataset.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1651,
+ "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": 1652,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "dataset_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetClientAsync",
+ "type": "reference",
+ "target": "3024"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1653,
+ "module": "_apify_client",
+ "name": "datasets",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 684
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the dataset collection, allowing to list and create datasets."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1654,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "datasets",
+ "parameters": [],
+ "type": {
+ "name": "DatasetCollectionClientAsync",
+ "type": "reference",
+ "target": "3445"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific key-value store.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1655,
+ "module": "_apify_client",
+ "name": "key_value_store",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific key-value store.\n",
+ "args": {
+ "key_value_store_id": "ID of the key-value store to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 688
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific key-value store.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1656,
+ "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": 1657,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key_value_store_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStoreClientAsync",
+ "type": "reference",
+ "target": "3781"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1658,
+ "module": "_apify_client",
+ "name": "key_value_stores",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 696
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1659,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "key_value_stores",
+ "parameters": [],
+ "type": {
+ "name": "KeyValueStoreCollectionClientAsync",
+ "type": "reference",
+ "target": "2496"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific request queue.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1660,
+ "module": "_apify_client",
+ "name": "request_queue",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific request queue.\n",
+ "args": {
+ "request_queue_id": "ID of the request queue to be manipulated.",
+ "client_key": "A unique identifier of the client accessing the request queue."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 700
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific request queue.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1661,
+ "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": 1662,
+ "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": 1663,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueueClientAsync",
+ "type": "reference",
+ "target": "2176"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1664,
+ "module": "_apify_client",
+ "name": "request_queues",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 709
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the request queue collection, allowing to list and create request queues."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1665,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "request_queues",
+ "parameters": [],
+ "type": {
+ "name": "RequestQueueCollectionClientAsync",
+ "type": "reference",
+ "target": "2603"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1666,
+ "module": "_apify_client",
+ "name": "webhook",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific webhook.\n",
+ "args": {
+ "webhook_id": "ID of the webhook to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 713
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1667,
+ "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": 1668,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhook_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookClientAsync",
+ "type": "reference",
+ "target": "3984"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1669,
+ "module": "_apify_client",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 721
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1670,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClientAsync",
+ "type": "reference",
+ "target": "3923"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook dispatch.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1671,
+ "module": "_apify_client",
+ "name": "webhook_dispatch",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific webhook dispatch.\n",
+ "args": {
+ "webhook_dispatch_id": "ID of the webhook dispatch to access."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 725
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific webhook dispatch.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1672,
+ "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": 1673,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhook_dispatch_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatchClientAsync",
+ "type": "reference",
+ "target": "2461"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1674,
+ "module": "_apify_client",
+ "name": "webhook_dispatches",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 733
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1675,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhook_dispatches",
+ "parameters": [],
+ "type": {
+ "name": "WebhookDispatchCollectionClientAsync",
+ "type": "reference",
+ "target": "2343"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific schedule.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1676,
+ "module": "_apify_client",
+ "name": "schedule",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific schedule.\n",
+ "args": {
+ "schedule_id": "ID of the schedule to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 737
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific schedule.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1677,
+ "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": 1678,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schedule_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ScheduleClientAsync",
+ "type": "reference",
+ "target": "2028"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1679,
+ "module": "_apify_client",
+ "name": "schedules",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 745
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the schedule collection, allowing to list and create schedules."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1680,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "schedules",
+ "parameters": [],
+ "type": {
+ "name": "ScheduleCollectionClientAsync",
+ "type": "reference",
+ "target": "3345"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1681,
+ "module": "_apify_client",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n",
+ "args": {
+ "build_or_run_id": "ID of the Actor build or run for which to access the log."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 749
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for retrieving logs of an Actor build or run.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1682,
+ "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": 1683,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_or_run_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "LogClientAsync",
+ "type": "reference",
+ "target": "2275"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor task.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1684,
+ "module": "_apify_client",
+ "name": "task",
+ "parsedDocstring": {
+ "text": "Get the sub-client for a specific Actor task.\n",
+ "args": {
+ "task_id": "ID of the task to be manipulated."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 757
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for a specific Actor task.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1685,
+ "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": 1686,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "TaskClientAsync",
+ "type": "reference",
+ "target": "2811"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1687,
+ "module": "_apify_client",
+ "name": "tasks",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 765
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1688,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "tasks",
+ "parameters": [],
+ "type": {
+ "name": "TaskCollectionClientAsync",
+ "type": "reference",
+ "target": "2662"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for querying user data.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1689,
+ "module": "_apify_client",
+ "name": "user",
+ "parsedDocstring": {
+ "text": "Get the sub-client for querying user data.\n",
+ "args": {
+ "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 769
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for querying user data.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1690,
+ "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": 1691,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "user_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "UserClientAsync",
+ "type": "reference",
+ "target": "2074"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1692,
+ "module": "_apify_client",
+ "name": "store",
+ "parsedDocstring": {
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 777
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1693,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "store",
+ "parameters": [],
+ "type": {
+ "name": "StoreCollectionClientAsync",
+ "type": "reference",
+ "target": "2721"
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Apify API clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1615,
+ 1635,
+ 1638,
+ 1640,
+ 1643,
+ 1650,
+ 1653,
+ 1655,
+ 1658,
+ 1681,
+ 1660,
+ 1664,
+ 1645,
+ 1648,
+ 1676,
+ 1679,
+ 1692,
+ 1684,
+ 1687,
+ 1689,
+ 1666,
+ 1671,
+ 1674,
+ 1669,
+ 1627
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 1634,
+ 1633
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1614,
+ "module": "_apify_client",
+ "name": "ApifyClientAsync",
+ "parsedDocstring": {
+ "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_apify_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 430
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1694,
+ "module": "__init__",
+ "name": "__version__",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/__init__.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 5
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the logger used throughout the library."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1695,
+ "module": "_logging",
+ "name": "logger_name",
+ "parsedDocstring": {
+ "text": "Name of the logger used throughout the library."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 19
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Logger used throughout the library."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1696,
+ "module": "_logging",
+ "name": "logger",
+ "parsedDocstring": {
+ "text": "Logger used throughout the library."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 22
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1698,
+ "module": "_logging",
+ "name": "attempt",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "ContextVar",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1699,
+ "module": "_logging",
+ "name": "client_method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 30
+ }
+ ],
+ "type": {
+ "name": "ContextVar",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1700,
+ "module": "_logging",
+ "name": "method",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "ContextVar",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1701,
+ "module": "_logging",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "ContextVar",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1702,
+ "module": "_logging",
+ "name": "url",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "ContextVar",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1698,
+ 1699,
+ 1700,
+ 1701,
+ 1702
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1697,
+ "module": "_logging",
+ "name": "LogContext",
+ "parsedDocstring": {
+ "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1703,
+ "module": "_logging",
+ "name": "log_context",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wrap all public methods in the class with logging context injection."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1705,
+ "module": "_logging",
+ "name": "__new__",
+ "parsedDocstring": {
+ "text": "Wrap all public methods in the class with logging context injection."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 48
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wrap all public methods in the class with logging context injection."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1706,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__new__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1707,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1708,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "bases",
+ "type": {
+ "name": "tuple",
+ "type": "reference"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1709,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "attrs",
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "WithLogDetailsClient",
+ "type": "reference",
+ "target": "1704"
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Metaclass that wraps public methods to inject client details into log context."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1705
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1704,
+ "module": "_logging",
+ "name": "WithLogDetailsClient",
+ "parsedDocstring": {
+ "text": "Metaclass that wraps public methods to inject client details into log context."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 45
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format log by prepending colored logger name.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1711,
+ "module": "_logging",
+ "name": "format",
+ "parsedDocstring": {
+ "text": "Format log by prepending colored logger name.\n",
+ "args": {
+ "record": "The log record to format.\n"
+ },
+ "returns": "Formatted log message with colored logger name prefix."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 60
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Formatted log message with colored logger name prefix."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format log by prepending colored logger name.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1712,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "format",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The log record to format.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1713,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "record",
+ "type": {
+ "name": "logging.LogRecord",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Log formatter that prepends colored logger name to messages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1711
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1710,
+ "module": "_logging",
+ "name": "RedirectLogFormatter",
+ "parsedDocstring": {
+ "text": "Log formatter that prepends colored logger name to messages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 57
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a logger for redirecting logs from another Actor.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1714,
+ "module": "_logging",
+ "name": "create_redirect_logger",
+ "parsedDocstring": {
+ "text": "Create a logger for redirecting logs from another Actor.\n",
+ "args": {
+ "name": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n"
+ },
+ "returns": "Configured logger with RedirectLogFormatter."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 74
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Configured logger with RedirectLogFormatter."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a logger for redirecting logs from another Actor.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1715,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create_redirect_logger",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1716,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add log context variables to the record."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1718,
+ "module": "_logging",
+ "name": "filter",
+ "parsedDocstring": {
+ "text": "Add log context variables to the record."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 102
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add log context variables to the record."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1719,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "filter",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1720,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "record",
+ "type": {
+ "name": "logging.LogRecord",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter that injects current log context into all log records."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1718
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1717,
+ "module": "_logging",
+ "name": "_ContextInjectingFilter",
+ "parsedDocstring": {
+ "text": "Filter that injects current log context into all log records."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_logging.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 99
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1721,
+ "module": "_utils",
+ "name": "T",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 27
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Convert timedelta to seconds.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1722,
+ "module": "_utils",
+ "name": "to_seconds",
+ "parsedDocstring": {
+ "text": "Convert timedelta to seconds.\n",
+ "args": {
+ "td": "The timedelta to convert, or None.",
+ "as_int": "If True, round and return as int. Defaults to False.\n"
+ },
+ "returns": "The total seconds as a float (or int if as_int=True), or None if input is None."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 43
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The total seconds as a float (or int if as_int=True), or None if input is None."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Convert timedelta to seconds.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1723,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "to_seconds",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The timedelta to convert, or None."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1724,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "td",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, round and return as int. Defaults to False.\n"
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1725,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "as_int",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "float | int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "float"
+ },
+ {
+ "type": "reference",
+ "name": "int"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1726,
+ "module": "_utils",
+ "name": "catch_not_found_or_throw",
+ "parsedDocstring": {
+ "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n",
+ "args": {
+ "exc": "The API error to check.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 59
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1727,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "catch_not_found_or_throw",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The API error to check.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1728,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc",
+ "type": {
+ "name": "ApifyApiError",
+ "type": "reference",
+ "target": "17"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1729,
+ "module": "_utils",
+ "name": "catch_not_found_for_resource_or_throw",
+ "parsedDocstring": {
+ "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1730,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "catch_not_found_for_resource_or_throw",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1731,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc",
+ "type": {
+ "name": "ApifyApiError",
+ "type": "reference",
+ "target": "17"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1732,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode a value for storage in a key-value store record.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1733,
+ "module": "_utils",
+ "name": "encode_key_value_store_record_value",
+ "parsedDocstring": {
+ "text": "Encode a value for storage in a key-value store record.\n",
+ "args": {
+ "value": "The value to encode (can be dict, str, bytes, or file-like object).",
+ "content_type": "The content type; if None, it's inferred from the value type.\n"
+ },
+ "returns": "A tuple of (encoded_value, content_type)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 84
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A tuple of (encoded_value, content_type)."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode a value for storage in a key-value store record.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1734,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "encode_key_value_store_record_value",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The value to encode (can be dict, str, bytes, or file-like object)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1735,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type; if None, it's inferred from the value type.\n"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1736,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "tuple",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Any"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1737,
+ "module": "_utils",
+ "name": "is_retryable_error",
+ "parsedDocstring": {
+ "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 118
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1738,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "is_retryable_error",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1739,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc",
+ "type": {
+ "name": "Exception",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1740,
+ "module": "_utils",
+ "name": "to_safe_id",
+ "parsedDocstring": {
+ "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n",
+ "args": {
+ "id": "The resource identifier in format `resource_id` or `username/resource_id`.\n"
+ },
+ "returns": "The resource identifier with `/` characters replaced by `~`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 134
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource identifier with `/` characters replaced by `~`."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1741,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "to_safe_id",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The resource identifier in format `resource_id` or `username/resource_id`.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1742,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse the API response as a dictionary and validate its type.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1743,
+ "module": "_utils",
+ "name": "response_to_dict",
+ "parsedDocstring": {
+ "text": "Parse the API response as a dictionary and validate its type.\n",
+ "args": {
+ "response": "The HTTP response object from the API.\n"
+ },
+ "returns": "The parsed response as a dictionary."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 146
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The parsed response as a dictionary."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse the API response as a dictionary and validate its type.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1744,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "response_to_dict",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object from the API.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1745,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse the API response as a list and validate its type.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1746,
+ "module": "_utils",
+ "name": "response_to_list",
+ "parsedDocstring": {
+ "text": "Parse the API response as a list and validate its type.\n",
+ "args": {
+ "response": "The HTTP response object from the API.\n"
+ },
+ "returns": "The parsed response as a list."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 166
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The parsed response as a list."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse the API response as a list and validate its type.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1747,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "response_to_list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object from the API.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1748,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "response",
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "target": "2297"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode an integer to a base62 string.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1749,
+ "module": "_utils",
+ "name": "encode_base62",
+ "parsedDocstring": {
+ "text": "Encode an integer to a base62 string.\n",
+ "args": {
+ "num": "The number to encode.\n"
+ },
+ "returns": "The base62-encoded string."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 189
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The base62-encoded string."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode an integer to a base62 string.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1750,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "encode_base62",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number to encode.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1751,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "num",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1752,
+ "module": "_utils",
+ "name": "create_hmac_signature",
+ "parsedDocstring": {
+ "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n",
+ "args": {
+ "secret_key": "The secret key used for signing.",
+ "message": "The message to be signed.\n"
+ },
+ "returns": "The base62-encoded signature."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 211
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The base62-encoded signature."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1753,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create_hmac_signature",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The secret key used for signing."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1754,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "secret_key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The message to be signed.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1755,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "message",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1756,
+ "module": "_utils",
+ "name": "create_storage_content_signature",
+ "parsedDocstring": {
+ "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n",
+ "args": {
+ "resource_id": "The unique identifier of the storage resource.",
+ "url_signing_secret_key": "The secret key for signing the URL.",
+ "expires_in": "Optional expiration duration; if None, the signature never expires.",
+ "version": "The signature version number (default: 0).\n"
+ },
+ "returns": "The base64url-encoded signature string."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 230
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The base64url-encoded signature string."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1757,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create_storage_content_signature",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The unique identifier of the storage resource."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1758,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The secret key for signing the URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1759,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "url_signing_secret_key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional expiration duration; if None, the signature never expires."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1760,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "expires_in",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The signature version number (default: 0).\n"
+ }
+ ]
+ },
+ "defaultValue": "0",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1761,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "version",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Warn if custom headers override important default headers."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1762,
+ "module": "_utils",
+ "name": "check_custom_headers",
+ "parsedDocstring": {
+ "text": "Warn if custom headers override important default headers."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 261
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Warn if custom headers override important default headers."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1763,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "check_custom_headers",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1764,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "class_name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1765,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1766,
+ "module": "_utils",
+ "name": "encode_webhooks_to_base64",
+ "parsedDocstring": {
+ "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_utils.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 286
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1767,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "encode_webhooks_to_base64",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1768,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1770,
+ "module": "_status_message_watcher",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "flags": {},
+ "id": 1771,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1772,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "defaultValue": "timedelta(seconds=5)",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1773,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "check_period",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class for polling and logging Actor run status messages."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1770
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1769,
+ "module": "_status_message_watcher",
+ "name": "StatusMessageWatcherBase",
+ "parsedDocstring": {
+ "text": "Base class for polling and logging Actor run status messages."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 22
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "StatusMessageWatcherAsync",
+ "target": "1774",
+ "type": "reference"
+ },
+ {
+ "name": "StatusMessageWatcher",
+ "target": "1791",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StatusMessageWatcherAsync`.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1775,
+ "module": "_status_message_watcher",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize `StatusMessageWatcherAsync`.\n",
+ "args": {
+ "run_client": "The run client used to poll the Actor run status and status message.",
+ "to_logger": "The logger to which the status messages will be forwarded.",
+ "check_period": "How often to poll the status message."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StatusMessageWatcherAsync`.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1776,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The run client used to poll the Actor run status and status message."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1777,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_client",
+ "type": {
+ "name": "RunClientAsync",
+ "type": "reference",
+ "target": "3200"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The logger to which the status messages will be forwarded."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1778,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How often to poll the status message."
+ }
+ ]
+ },
+ "defaultValue": "timedelta(seconds=1)",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1779,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "check_period",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "StatusMessageWatcherBase.__init__",
+ "target": 1770,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "StatusMessageWatcherBase.__init__",
+ "target": 1770,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1780,
+ "module": "_status_message_watcher",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 86
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1781,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "start",
+ "parameters": [],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the logging task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1782,
+ "module": "_status_message_watcher",
+ "name": "stop",
+ "parsedDocstring": {
+ "text": "Stop the logging task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 96
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the logging task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1783,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "stop",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the logging task within the context. Exiting the context will cancel the logging task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1784,
+ "module": "_status_message_watcher",
+ "name": "__aenter__",
+ "parsedDocstring": {
+ "text": "Start the logging task within the context. Exiting the context will cancel the logging task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the logging task within the context. Exiting the context will cancel the logging task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1785,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "__aenter__",
+ "parameters": [],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Cancel the logging task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1786,
+ "module": "_status_message_watcher",
+ "name": "__aexit__",
+ "parsedDocstring": {
+ "text": "Cancel the logging task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 114
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Cancel the logging task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1787,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "__aexit__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1788,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_type",
+ "type": {
+ "name": "type[BaseException] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "type",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ }
+ ],
+ "target": "524"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1789,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_val",
+ "type": {
+ "name": "BaseException | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1790,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_tb",
+ "type": {
+ "name": "TracebackType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TracebackType"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Other')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1784,
+ 1786,
+ 1775,
+ 1780,
+ 1782
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1774,
+ "module": "_status_message_watcher",
+ "name": "StatusMessageWatcherAsync",
+ "parsedDocstring": {
+ "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 61
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "StatusMessageWatcherBase",
+ "target": "1769",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StatusMessageWatcher`.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1792,
+ "module": "_status_message_watcher",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize `StatusMessageWatcher`.\n",
+ "args": {
+ "run_client": "The run client used to poll the Actor run status and status message.",
+ "to_logger": "The logger to which the status messages will be forwarded.",
+ "check_period": "How often to poll the status message."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 142
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize `StatusMessageWatcher`.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1793,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The run client used to poll the Actor run status and status message."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1794,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_client",
+ "type": {
+ "name": "RunClient",
+ "type": "reference",
+ "target": "3131"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The logger to which the status messages will be forwarded."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1795,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How often to poll the status message."
+ }
+ ]
+ },
+ "defaultValue": "timedelta(seconds=1)",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1796,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "check_period",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "StatusMessageWatcherBase.__init__",
+ "target": 1770,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "StatusMessageWatcherBase.__init__",
+ "target": 1770,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1797,
+ "module": "_status_message_watcher",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 157
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1798,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "start",
+ "parameters": [],
+ "type": {
+ "name": "Thread",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signal the logging thread to stop logging and wait for it to finish."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1799,
+ "module": "_status_message_watcher",
+ "name": "stop",
+ "parsedDocstring": {
+ "text": "Signal the logging thread to stop logging and wait for it to finish."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 169
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signal the logging thread to stop logging and wait for it to finish."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1800,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "stop",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the logging thread within the context. Exiting the context will stop the logging thread."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1801,
+ "module": "_status_message_watcher",
+ "name": "__enter__",
+ "parsedDocstring": {
+ "text": "Start the logging thread within the context. Exiting the context will stop the logging thread."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 178
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the logging thread within the context. Exiting the context will stop the logging thread."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1802,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__enter__",
+ "parameters": [],
+ "type": {
+ "name": "Self",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the logging thread."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1803,
+ "module": "_status_message_watcher",
+ "name": "__exit__",
+ "parsedDocstring": {
+ "text": "Stop the logging thread."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 183
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Stop the logging thread."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1804,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__exit__",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1805,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_type",
+ "type": {
+ "name": "type[BaseException] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "type",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ }
+ ],
+ "target": "524"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1806,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_val",
+ "type": {
+ "name": "BaseException | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "BaseException"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1807,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exc_tb",
+ "type": {
+ "name": "TracebackType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "TracebackType"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Other')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1801,
+ 1803,
+ 1792,
+ 1797,
+ 1799
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1791,
+ "module": "_status_message_watcher",
+ "name": "StatusMessageWatcher",
+ "parsedDocstring": {
+ "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_status_message_watcher.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 131
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "StatusMessageWatcherBase",
+ "target": "1769",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1809,
+ "module": "_client_registry",
+ "name": "actor_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 73
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorClient",
+ "target": "3502"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1810,
+ "module": "_client_registry",
+ "name": "actor_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 74
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorCollectionClient",
+ "target": "2360"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1811,
+ "module": "_client_registry",
+ "name": "actor_env_var_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorEnvVarClient",
+ "target": "3856"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1812,
+ "module": "_client_registry",
+ "name": "actor_env_var_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 76
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorEnvVarCollectionClient",
+ "target": "2292"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1813,
+ "module": "_client_registry",
+ "name": "actor_version_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 77
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorVersionClient",
+ "target": "2522"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1814,
+ "module": "_client_registry",
+ "name": "actor_version_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 78
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorVersionCollectionClient",
+ "target": "3373"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1815,
+ "module": "_client_registry",
+ "name": "build_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 79
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildClient",
+ "target": "3269"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1816,
+ "module": "_client_registry",
+ "name": "build_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 80
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildCollectionClient",
+ "target": "2876"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1817,
+ "module": "_client_registry",
+ "name": "dataset_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 81
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetClient",
+ "target": "2917"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1818,
+ "module": "_client_registry",
+ "name": "dataset_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 82
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetCollectionClient",
+ "target": "3419"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1819,
+ "module": "_client_registry",
+ "name": "key_value_store_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 83
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreClient",
+ "target": "3706"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1820,
+ "module": "_client_registry",
+ "name": "key_value_store_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 84
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreCollectionClient",
+ "target": "2470"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1821,
+ "module": "_client_registry",
+ "name": "log_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 85
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "LogClient",
+ "target": "2258"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1822,
+ "module": "_client_registry",
+ "name": "request_queue_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 86
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueClient",
+ "target": "2094"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1823,
+ "module": "_client_registry",
+ "name": "request_queue_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 87
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueCollectionClient",
+ "target": "2578"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1824,
+ "module": "_client_registry",
+ "name": "run_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 88
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunClient",
+ "target": "3131"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1825,
+ "module": "_client_registry",
+ "name": "run_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 89
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunCollectionClient",
+ "target": "4014"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1826,
+ "module": "_client_registry",
+ "name": "schedule_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 90
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleClient",
+ "target": "2002"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1827,
+ "module": "_client_registry",
+ "name": "schedule_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 91
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleCollectionClient",
+ "target": "3317"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1828,
+ "module": "_client_registry",
+ "name": "store_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 92
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "StoreCollectionClient",
+ "target": "2696"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1829,
+ "module": "_client_registry",
+ "name": "task_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 93
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskClient",
+ "target": "2746"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1830,
+ "module": "_client_registry",
+ "name": "task_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 94
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskCollectionClient",
+ "target": "2628"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1831,
+ "module": "_client_registry",
+ "name": "user_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 95
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "UserClient",
+ "target": "2054"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1832,
+ "module": "_client_registry",
+ "name": "webhook_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 96
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookClient",
+ "target": "3954"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1833,
+ "module": "_client_registry",
+ "name": "webhook_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 97
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookCollectionClient",
+ "target": "3892"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1834,
+ "module": "_client_registry",
+ "name": "webhook_dispatch_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 98
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatchClient",
+ "target": "2452"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1835,
+ "module": "_client_registry",
+ "name": "webhook_dispatch_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 99
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatchCollectionClient",
+ "target": "2326"
+ }
+ ],
+ "target": "524"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "dataclass"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1809,
+ 1810,
+ 1811,
+ 1812,
+ 1813,
+ 1814,
+ 1815,
+ 1816,
+ 1817,
+ 1818,
+ 1819,
+ 1820,
+ 1821,
+ 1822,
+ 1823,
+ 1824,
+ 1825,
+ 1826,
+ 1827,
+ 1828,
+ 1829,
+ 1830,
+ 1831,
+ 1832,
+ 1833,
+ 1834,
+ 1835
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1808,
+ "module": "_client_registry",
+ "name": "ClientRegistry",
+ "parsedDocstring": {
+ "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 66
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1837,
+ "module": "_client_registry",
+ "name": "actor_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 110
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorClientAsync",
+ "target": "3604"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1838,
+ "module": "_client_registry",
+ "name": "actor_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 111
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorCollectionClientAsync",
+ "target": "2406"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1839,
+ "module": "_client_registry",
+ "name": "actor_env_var_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 112
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorEnvVarClientAsync",
+ "target": "3874"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1840,
+ "module": "_client_registry",
+ "name": "actor_env_var_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 113
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorEnvVarCollectionClientAsync",
+ "target": "2309"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1841,
+ "module": "_client_registry",
+ "name": "actor_version_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 114
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorVersionClientAsync",
+ "target": "2550"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1842,
+ "module": "_client_registry",
+ "name": "actor_version_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorVersionCollectionClientAsync",
+ "target": "3396"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1843,
+ "module": "_client_registry",
+ "name": "build_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 116
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildClientAsync",
+ "target": "3293"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1844,
+ "module": "_client_registry",
+ "name": "build_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 117
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildCollectionClientAsync",
+ "target": "2893"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1845,
+ "module": "_client_registry",
+ "name": "dataset_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 118
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetClientAsync",
+ "target": "3024"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1846,
+ "module": "_client_registry",
+ "name": "dataset_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 119
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetCollectionClientAsync",
+ "target": "3445"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1847,
+ "module": "_client_registry",
+ "name": "key_value_store_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 120
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreClientAsync",
+ "target": "3781"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1848,
+ "module": "_client_registry",
+ "name": "key_value_store_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 121
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreCollectionClientAsync",
+ "target": "2496"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1849,
+ "module": "_client_registry",
+ "name": "log_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 122
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "LogClientAsync",
+ "target": "2275"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1850,
+ "module": "_client_registry",
+ "name": "request_queue_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 123
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueClientAsync",
+ "target": "2176"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1851,
+ "module": "_client_registry",
+ "name": "request_queue_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 124
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueCollectionClientAsync",
+ "target": "2603"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1852,
+ "module": "_client_registry",
+ "name": "run_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 125
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunClientAsync",
+ "target": "3200"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1853,
+ "module": "_client_registry",
+ "name": "run_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 126
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunCollectionClientAsync",
+ "target": "4037"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1854,
+ "module": "_client_registry",
+ "name": "schedule_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 127
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleClientAsync",
+ "target": "2028"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1855,
+ "module": "_client_registry",
+ "name": "schedule_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 128
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleCollectionClientAsync",
+ "target": "3345"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1856,
+ "module": "_client_registry",
+ "name": "store_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 129
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "StoreCollectionClientAsync",
+ "target": "2721"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1857,
+ "module": "_client_registry",
+ "name": "task_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 130
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskClientAsync",
+ "target": "2811"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1858,
+ "module": "_client_registry",
+ "name": "task_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 131
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskCollectionClientAsync",
+ "target": "2662"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1859,
+ "module": "_client_registry",
+ "name": "user_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 132
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "UserClientAsync",
+ "target": "2074"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1860,
+ "module": "_client_registry",
+ "name": "webhook_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 133
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookClientAsync",
+ "target": "3984"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1861,
+ "module": "_client_registry",
+ "name": "webhook_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 134
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookCollectionClientAsync",
+ "target": "3923"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1862,
+ "module": "_client_registry",
+ "name": "webhook_dispatch_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 135
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatchClientAsync",
+ "target": "2461"
+ }
+ ],
+ "target": "524"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1863,
+ "module": "_client_registry",
+ "name": "webhook_dispatch_collection_client",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 136
+ }
+ ],
+ "type": {
+ "name": "type",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatchCollectionClientAsync",
+ "target": "2343"
+ }
+ ],
+ "target": "524"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "dataclass"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1837,
+ 1838,
+ 1839,
+ 1840,
+ 1841,
+ 1842,
+ 1843,
+ 1844,
+ 1845,
+ 1846,
+ 1847,
+ 1848,
+ 1849,
+ 1850,
+ 1851,
+ 1852,
+ 1853,
+ 1854,
+ 1855,
+ 1856,
+ 1857,
+ 1858,
+ 1859,
+ 1860,
+ 1861,
+ 1862,
+ 1863
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1836,
+ "module": "_client_registry",
+ "name": "ClientRegistryAsync",
+ "parsedDocstring": {
+ "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_client_registry.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 103
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1864,
+ "module": "_pagination",
+ "name": "T",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 10
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1865,
+ "module": "_pagination",
+ "name": "DEFAULT_CHUNK_SIZE",
+ "parsedDocstring": {
+ "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 12
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1867,
+ "module": "_pagination",
+ "name": "items",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 27
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1867
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1866,
+ "module": "_pagination",
+ "name": "HasItems",
+ "parsedDocstring": {
+ "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 19
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1868,
+ "module": "_pagination",
+ "name": "get_items_iterator",
+ "parsedDocstring": {
+ "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n",
+ "args": {
+ "callback": "Function returning a single page of items.",
+ "limit": "Maximum total number of items to yield across all pages. `None` or `0` means no limit.",
+ "offset": "Starting offset for the first page.",
+ "chunk_size": "Maximum number of items requested per API call. `None` or `0` lets the API decide."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 30
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1869,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_items_iterator",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Function returning a single page of items."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1870,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "callback",
+ "type": {
+ "name": "Callable",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "..."
+ },
+ {
+ "type": "reference",
+ "name": "HasItems",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ],
+ "target": "1866"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum total number of items to yield across all pages. `None` or `0` means no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1871,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Starting offset for the first page."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1872,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items requested per API call. `None` or `0` lets the API decide."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1873,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1874,
+ "module": "_pagination",
+ "name": "get_items_iterator_async",
+ "parsedDocstring": {
+ "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 71
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1875,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_items_iterator_async",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1876,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "callback",
+ "type": {
+ "name": "Callable",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "..."
+ },
+ {
+ "type": "reference",
+ "name": "Awaitable",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "HasItems",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ],
+ "target": "1866"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1877,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1878,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1879,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "T",
+ "target": "9"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1880,
+ "module": "_pagination",
+ "name": "get_cursor_iterator",
+ "parsedDocstring": {
+ "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n",
+ "args": {
+ "callback": "Function returning a single page of items. Receives `cursor` and `limit` kwargs.",
+ "cursor": "Value of the cursor for the first request, or `None` to start from the beginning.",
+ "limit": "Maximum total number of items to yield across all pages.",
+ "chunk_size": "Maximum number of items requested per API call."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 117
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1881,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_cursor_iterator",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Function returning a single page of items. Receives `cursor` and `limit` kwargs."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1882,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "callback",
+ "type": {
+ "name": "Callable",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "..."
+ },
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ListOfKeys",
+ "target": "723"
+ },
+ {
+ "type": "reference",
+ "name": "ListOfRequests",
+ "target": "737"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Value of the cursor for the first request, or `None` to start from the beginning."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1883,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum total number of items to yield across all pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1884,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items requested per API call."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1885,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator[KeyValueStoreKey] | Iterator[Request]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Iterator",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreKey",
+ "target": "665"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "Iterator",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Async variant of :func:`get_cursor_iterator`."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1886,
+ "module": "_pagination",
+ "name": "get_cursor_iterator_async",
+ "parsedDocstring": {
+ "text": "Async variant of :func:`get_cursor_iterator`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_pagination.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 172
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Async variant of :func:`get_cursor_iterator`."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1887,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_cursor_iterator_async",
+ "parameters": [
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 1888,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "callback",
+ "type": {
+ "name": "Callable",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "..."
+ },
+ {
+ "type": "reference",
+ "name": "Awaitable",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ListOfKeys",
+ "target": "723"
+ },
+ {
+ "type": "reference",
+ "name": "ListOfRequests",
+ "target": "737"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1889,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1890,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1891,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator[KeyValueStoreKey] | AsyncIterator[Request]",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "AsyncIterator",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreKey",
+ "target": "665"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "AsyncIterator",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Status of an Actor job (run or build)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1892,
+ "module": "_literals",
+ "name": "ActorJobStatus",
+ "parsedDocstring": {
+ "text": "Status of an Actor job (run or build)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 7
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1893,
+ "module": "_literals",
+ "name": "ActorPermissionLevel",
+ "parsedDocstring": {
+ "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Machine-processable error type identifier."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1894,
+ "module": "_literals",
+ "name": "ErrorType",
+ "parsedDocstring": {
+ "text": "Machine-processable error type identifier."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 27
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Defines the general access level for the resource."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1895,
+ "module": "_literals",
+ "name": "GeneralAccess",
+ "parsedDocstring": {
+ "text": "Defines the general access level for the resource."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 423
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1896,
+ "module": "_literals",
+ "name": "HttpMethod",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 432
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1897,
+ "module": "_literals",
+ "name": "RunOrigin",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 445
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1898,
+ "module": "_literals",
+ "name": "SourceCodeFileFormat",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 459
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1899,
+ "module": "_literals",
+ "name": "StorageOwnership",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 465
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1900,
+ "module": "_literals",
+ "name": "VersionSourceType",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 471
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Status of the webhook dispatch indicating whether the HTTP request was successful."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1901,
+ "module": "_literals",
+ "name": "WebhookDispatchStatus",
+ "parsedDocstring": {
+ "text": "Status of the webhook dispatch indicating whether the HTTP request was successful."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 480
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Type of event that triggers the webhook."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1902,
+ "module": "_literals",
+ "name": "WebhookEventType",
+ "parsedDocstring": {
+ "text": "Type of event that triggers the webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_literals.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 488
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP status code of the response."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1904,
+ "module": "http_clients._base",
+ "name": "status_code",
+ "parsedDocstring": {
+ "text": "HTTP status code of the response."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response body decoded as text."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1905,
+ "module": "http_clients._base",
+ "name": "text",
+ "parsedDocstring": {
+ "text": "Response body decoded as text."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw response body as bytes."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1906,
+ "module": "http_clients._base",
+ "name": "content",
+ "parsedDocstring": {
+ "text": "Raw response body as bytes."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 50
+ }
+ ],
+ "type": {
+ "name": "bytes",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Response headers as a mapping."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1907,
+ "module": "http_clients._base",
+ "name": "headers",
+ "parsedDocstring": {
+ "text": "Response headers as a mapping."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Mapping",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse response body as JSON."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1908,
+ "module": "http_clients._base",
+ "name": "json",
+ "parsedDocstring": {
+ "text": "Parse response body as JSON."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 57
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parse response body as JSON."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1909,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "json",
+ "parameters": [],
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Read the entire response body."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1910,
+ "module": "http_clients._base",
+ "name": "read",
+ "parsedDocstring": {
+ "text": "Read the entire response body."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 60
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Read the entire response body."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1911,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "read",
+ "parameters": [],
+ "type": {
+ "name": "bytes",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Read the entire response body asynchronously."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1912,
+ "module": "http_clients._base",
+ "name": "aread",
+ "parsedDocstring": {
+ "text": "Read the entire response body asynchronously."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Read the entire response body asynchronously."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1913,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "aread",
+ "parameters": [],
+ "type": {
+ "name": "bytes",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Close the response and release the connection."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1914,
+ "module": "http_clients._base",
+ "name": "close",
+ "parsedDocstring": {
+ "text": "Close the response and release the connection."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 66
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Close the response and release the connection."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1915,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "close",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Close the response and release the connection asynchronously."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1916,
+ "module": "http_clients._base",
+ "name": "aclose",
+ "parsedDocstring": {
+ "text": "Close the response and release the connection asynchronously."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 69
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Close the response and release the connection asynchronously."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1917,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "aclose",
+ "parameters": [],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the response body in bytes chunks."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1918,
+ "module": "http_clients._base",
+ "name": "iter_bytes",
+ "parsedDocstring": {
+ "text": "Iterate over the response body in bytes chunks."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the response body in bytes chunks."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1919,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iter_bytes",
+ "parameters": [],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the response body in bytes chunks asynchronously."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1920,
+ "module": "http_clients._base",
+ "name": "aiter_bytes",
+ "parsedDocstring": {
+ "text": "Iterate over the response body in bytes chunks asynchronously."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the response body in bytes chunks asynchronously."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1921,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "aiter_bytes",
+ "parameters": [],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ },
+ {
+ "name": "runtime_checkable"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1916,
+ 1920,
+ 1912,
+ 1914,
+ 1918,
+ 1908,
+ 1910
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 1906,
+ 1907,
+ 1904,
+ 1905
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 1903,
+ "module": "http_clients._base",
+ "name": "HttpResponse",
+ "parsedDocstring": {
+ "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1923,
+ "module": "http_clients._base",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the HTTP client base.\n",
+ "args": {
+ "token": "Apify API token for authentication.",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "max_retries": "Maximum number of retries for failed requests.",
+ "min_delay_between_retries": "Minimum delay between retries.",
+ "statistics": "Statistics tracker for API calls. Created automatically if not provided.",
+ "headers": "Additional HTTP headers to include in all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 91
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1924,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify API token for authentication."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1925,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1926,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1927,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1928,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1929,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of retries for failed requests."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1930,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum delay between retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1931,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics tracker for API calls. Created automatically if not provided."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1932,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "statistics",
+ "type": {
+ "name": "ClientStatistics | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ClientStatistics",
+ "target": "1"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1933,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1923
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1922,
+ "module": "http_clients._base",
+ "name": "HttpClientBase",
+ "parsedDocstring": {
+ "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 80
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "HttpClient",
+ "target": "1934",
+ "type": "reference"
+ },
+ {
+ "name": "HttpClientAsync",
+ "target": "1945",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request.\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "abstractmethod"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1935,
+ "module": "http_clients._base",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Make an HTTP request.\n",
+ "args": {
+ "method": "HTTP method (GET, POST, PUT, DELETE, etc.).",
+ "url": "Full URL to make the request to.",
+ "headers": "Additional headers to include in this request.",
+ "params": "Query parameters to append to the URL.",
+ "data": "Raw request body data. Cannot be used together with json.",
+ "json": "JSON-serializable data for the request body. Cannot be used together with data.",
+ "stream": "Whether to stream the response body.",
+ "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ },
+ "returns": "The HTTP response object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 252
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1936,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP method (GET, POST, PUT, DELETE, etc.)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1937,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Full URL to make the request to."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1938,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional headers to include in this request."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1939,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Query parameters to append to the URL."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1940,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw request body data. Cannot be used together with json."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1941,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data",
+ "type": {
+ "name": "str | bytes | bytearray | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "bytearray"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "JSON-serializable data for the request body. Cannot be used together with data."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1942,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "json",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to stream the response body."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1943,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "stream",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1944,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4116,
+ "module": "http_clients._base",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the HTTP client base.\n",
+ "args": {
+ "token": "Apify API token for authentication.",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "max_retries": "Maximum number of retries for failed requests.",
+ "min_delay_between_retries": "Minimum delay between retries.",
+ "statistics": "Statistics tracker for API calls. Created automatically if not provided.",
+ "headers": "Additional HTTP headers to include in all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 91
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1924,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify API token for authentication."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1925,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1926,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1927,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1928,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1929,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of retries for failed requests."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1930,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum delay between retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1931,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics tracker for API calls. Created automatically if not provided."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1932,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "statistics",
+ "type": {
+ "name": "ClientStatistics | None",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1933,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "HttpClientBase.__init__",
+ "target": 1923,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "HttpClientBase.__init__",
+ "target": 1923,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4116,
+ 1935
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1934,
+ "module": "http_clients._base",
+ "name": "HttpClient",
+ "parsedDocstring": {
+ "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 243
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "HttpClientBase",
+ "target": "1922",
+ "type": "reference"
+ }
+ ],
+ "extendedBy": [
+ {
+ "name": "ImpitHttpClient",
+ "target": "1958",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request.\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "abstractmethod"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 1946,
+ "module": "http_clients._base",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Make an HTTP request.\n",
+ "args": {
+ "method": "HTTP method (GET, POST, PUT, DELETE, etc.).",
+ "url": "Full URL to make the request to.",
+ "headers": "Additional headers to include in this request.",
+ "params": "Query parameters to append to the URL.",
+ "data": "Raw request body data. Cannot be used together with json.",
+ "json": "JSON-serializable data for the request body. Cannot be used together with data.",
+ "stream": "Whether to stream the response body.",
+ "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ },
+ "returns": "The HTTP response object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 296
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1947,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP method (GET, POST, PUT, DELETE, etc.)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1948,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Full URL to make the request to."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1949,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional headers to include in this request."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1950,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Query parameters to append to the URL."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1951,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw request body data. Cannot be used together with json."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1952,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data",
+ "type": {
+ "name": "str | bytes | bytearray | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "bytearray"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "JSON-serializable data for the request body. Cannot be used together with data."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1953,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "json",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to stream the response body."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1954,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "stream",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1955,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4117,
+ "module": "http_clients._base",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the HTTP client base.\n",
+ "args": {
+ "token": "Apify API token for authentication.",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "max_retries": "Maximum number of retries for failed requests.",
+ "min_delay_between_retries": "Minimum delay between retries.",
+ "statistics": "Statistics tracker for API calls. Created automatically if not provided.",
+ "headers": "Additional HTTP headers to include in all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 91
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the HTTP client base.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1924,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify API token for authentication."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1925,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1926,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1927,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1928,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1929,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of retries for failed requests."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1930,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum delay between retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1931,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics tracker for API calls. Created automatically if not provided."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1932,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "statistics",
+ "type": {
+ "name": "ClientStatistics | None",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1933,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "HttpClientBase.__init__",
+ "target": 1923,
+ "type": "reference"
+ }
+ }
+ ],
+ "inheritedFrom": {
+ "name": "HttpClientBase.__init__",
+ "target": 1923,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4117,
+ 1946
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1945,
+ "module": "http_clients._base",
+ "name": "HttpClientAsync",
+ "parsedDocstring": {
+ "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_base.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 288
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "HttpClientBase",
+ "target": "1922",
+ "type": "reference"
+ }
+ ],
+ "extendedBy": [
+ {
+ "name": "ImpitHttpClientAsync",
+ "target": "1980",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1956,
+ "module": "http_clients._impit",
+ "name": "T",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 34
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": ""
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 1957,
+ "module": "http_clients._impit",
+ "name": "logger",
+ "parsedDocstring": {
+ "text": ""
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Impit-based synchronous HTTP client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1959,
+ "module": "http_clients._impit",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the Impit-based synchronous HTTP client.\n",
+ "args": {
+ "token": "Apify API token for authentication.",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "max_retries": "Maximum number of retry attempts for failed requests.",
+ "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).",
+ "statistics": "Statistics tracker for API calls. Created automatically if not provided.",
+ "headers": "Additional HTTP headers to include in all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 64
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Impit-based synchronous HTTP client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1960,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify API token for authentication."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1961,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1962,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1963,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1964,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1965,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of retry attempts for failed requests."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1966,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum delay between retries (increases exponentially with each attempt)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1967,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics tracker for API calls. Created automatically if not provided."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1968,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "statistics",
+ "type": {
+ "name": "ClientStatistics | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ClientStatistics",
+ "target": "1"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1969,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "HttpClient.__init__",
+ "target": 4116,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "HttpClient.__init__",
+ "target": 4116,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1970,
+ "module": "http_clients._impit",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n",
+ "args": {
+ "method": "HTTP method (GET, POST, PUT, DELETE, etc.).",
+ "url": "Full URL to make the request to.",
+ "headers": "Additional headers to include.",
+ "params": "Query parameters to append to the URL.",
+ "data": "Raw request body data. Cannot be used together with json.",
+ "json": "JSON-serializable data for the request body. Cannot be used together with data.",
+ "stream": "Whether to stream the response body.",
+ "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ },
+ "returns": "The HTTP response object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 107
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1971,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP method (GET, POST, PUT, DELETE, etc.)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1972,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Full URL to make the request to."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1973,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional headers to include."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1974,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Query parameters to append to the URL."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1975,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw request body data. Cannot be used together with json."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1976,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data",
+ "type": {
+ "name": "str | bytes | bytearray | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "bytearray"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "JSON-serializable data for the request body. Cannot be used together with data."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1977,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "json",
+ "type": {
+ "name": "JsonSerializable | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "JsonSerializable",
+ "target": "15"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to stream the response body."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1978,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "stream",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1979,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ },
+ "overwrites": {
+ "name": "HttpClient.call",
+ "target": 1935,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "HttpClient.call",
+ "target": 1935,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1959,
+ 1970
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1958,
+ "module": "http_clients._impit",
+ "name": "ImpitHttpClient",
+ "parsedDocstring": {
+ "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 56
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "HttpClient",
+ "target": "1934",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Impit-based asynchronous HTTP client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1981,
+ "module": "http_clients._impit",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the Impit-based asynchronous HTTP client.\n",
+ "args": {
+ "token": "Apify API token for authentication.",
+ "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).",
+ "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).",
+ "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).",
+ "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.",
+ "max_retries": "Maximum number of retry attempts for failed requests.",
+ "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).",
+ "statistics": "Statistics tracker for API calls. Created automatically if not provided.",
+ "headers": "Additional HTTP headers to include in all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 311
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the Impit-based asynchronous HTTP client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1982,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Apify API token for authentication."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1983,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "token",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_SHORT",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1984,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_short",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MEDIUM",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1985,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_medium",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_LONG",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1986,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_long",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum timeout cap for exponential timeout growth across retries."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_TIMEOUT_MAX",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1987,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout_max",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of retry attempts for failed requests."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MAX_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1988,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_retries",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Minimum delay between retries (increases exponentially with each attempt)."
+ }
+ ]
+ },
+ "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1989,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "min_delay_between_retries",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Statistics tracker for API calls. Created automatically if not provided."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1990,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "statistics",
+ "type": {
+ "name": "ClientStatistics | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ClientStatistics",
+ "target": "1"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional HTTP headers to include in all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1991,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "HttpClientAsync.__init__",
+ "target": 4117,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "HttpClientAsync.__init__",
+ "target": 4117,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 1992,
+ "module": "http_clients._impit",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n",
+ "args": {
+ "method": "HTTP method (GET, POST, PUT, DELETE, etc.).",
+ "url": "Full URL to make the request to.",
+ "headers": "Additional headers to include.",
+ "params": "Query parameters to append to the URL.",
+ "data": "Raw request body data. Cannot be used together with json.",
+ "json": "JSON-serializable data for the request body. Cannot be used together with data.",
+ "stream": "Whether to stream the response body.",
+ "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ },
+ "returns": "The HTTP response object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 354
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The HTTP response object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Make an HTTP request with automatic retry and exponential backoff.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 1993,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP method (GET, POST, PUT, DELETE, etc.)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1994,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "method",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Full URL to make the request to."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 1995,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Additional headers to include."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1996,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers",
+ "type": {
+ "name": "dict[str, str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Query parameters to append to the URL."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1997,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict[str, Any] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Raw request body data. Cannot be used together with json."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1998,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data",
+ "type": {
+ "name": "str | bytes | bytearray | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "bytes"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "bytearray"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "JSON-serializable data for the request body. Cannot be used together with data."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 1999,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "json",
+ "type": {
+ "name": "JsonSerializable | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "JsonSerializable",
+ "target": "15"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to stream the response body."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2000,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "stream",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2001,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "HttpResponse",
+ "type": "reference",
+ "target": "1903"
+ },
+ "overwrites": {
+ "name": "HttpClientAsync.call",
+ "target": 1946,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "HttpClientAsync.call",
+ "target": 1946,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('HTTP clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1981,
+ 1992
+ ],
+ "title": "Methods"
+ }
+ ],
+ "id": 1980,
+ "module": "http_clients._impit",
+ "name": "ImpitHttpClientAsync",
+ "parsedDocstring": {
+ "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/http_clients/_impit.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 303
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "HttpClientAsync",
+ "target": "1945",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2003,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 28
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2008,
+ "module": "_resource_clients.schedule",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 41
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2009,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2010,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Schedule",
+ "target": "1197"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2011,
+ "module": "_resource_clients.schedule",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n",
+ "args": {
+ "cron_expression": "The cron expression used by this schedule.",
+ "is_enabled": "True if the schedule should be enabled.",
+ "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.",
+ "name": "The name of the schedule to create.",
+ "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.",
+ "description": "Description of this schedule.",
+ "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
+ "title": "A human-friendly equivalent of the name.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 57
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2012,
+ "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": 2013,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cron_expression",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "True if the schedule should be enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2014,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2015,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_exclusive",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the schedule to create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2016,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2017,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Description of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2018,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2019,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timezone",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2020,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2021,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule",
+ "type": "reference",
+ "target": "1197"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2022,
+ "module": "_resource_clients.schedule",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 103
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2023,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2024,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2025,
+ "module": "_resource_clients.schedule",
+ "name": "get_log",
+ "parsedDocstring": {
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Retrieved log of the given schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 113
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Retrieved log of the given schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2026,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_log",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2027,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleInvoked",
+ "target": "1224"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4089,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2003,
+ 2022,
+ 2008,
+ 2025,
+ 2011
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4089
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2002,
+ "module": "_resource_clients.schedule",
+ "name": "ScheduleClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2029,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 145
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2034,
+ "module": "_resource_clients.schedule",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 158
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2035,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2036,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Schedule",
+ "target": "1197"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2037,
+ "module": "_resource_clients.schedule",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n",
+ "args": {
+ "cron_expression": "The cron expression used by this schedule.",
+ "is_enabled": "True if the schedule should be enabled.",
+ "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.",
+ "name": "The name of the schedule to create.",
+ "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.",
+ "description": "Description of this schedule.",
+ "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
+ "title": "A human-friendly equivalent of the name.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 174
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2038,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The cron expression used by this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2039,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cron_expression",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "True if the schedule should be enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2040,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2041,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_exclusive",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the schedule to create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2042,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2043,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Description of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2044,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2045,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timezone",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2046,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2047,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule",
+ "type": "reference",
+ "target": "1197"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2048,
+ "module": "_resource_clients.schedule",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 220
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2049,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2050,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2051,
+ "module": "_resource_clients.schedule",
+ "name": "get_log",
+ "parsedDocstring": {
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Retrieved log of the given schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 230
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Retrieved log of the given schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2052,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_log",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2053,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleInvoked",
+ "target": "1224"
+ }
+ ],
+ "target": "2297"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4062,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2029,
+ 2048,
+ 2034,
+ 2051,
+ 2037
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4062
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2028,
+ "module": "_resource_clients.schedule",
+ "name": "ScheduleClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 138
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2055,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2060,
+ "module": "_resource_clients.user",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved user data, or None if the user does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved user data, or None if the user does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2061,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2062,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "UserPublicInfo | UserPrivateInfo | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "UserPublicInfo",
+ "target": "1413"
+ },
+ {
+ "type": "reference",
+ "name": "UserPrivateInfo",
+ "target": "1402"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2063,
+ "module": "_resource_clients.user",
+ "name": "monthly_usage",
+ "parsedDocstring": {
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved monthly usage."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved monthly usage."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2064,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "monthly_usage",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2065,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "MonthlyUsage",
+ "type": "reference",
+ "target": "792"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2066,
+ "module": "_resource_clients.user",
+ "name": "limits",
+ "parsedDocstring": {
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The account limits."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 94
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The account limits."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2067,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "limits",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2068,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AccountLimits",
+ "type": "reference",
+ "target": "187"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the account's limits manageable on your account's Limits page.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2069,
+ "module": "_resource_clients.user",
+ "name": "update_limits",
+ "parsedDocstring": {
+ "text": "Update the account's limits manageable on your account's Limits page.\n",
+ "args": {
+ "max_monthly_usage_usd": "Maximum monthly usage in USD.",
+ "data_retention_days": "Data retention period in days.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 120
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the account's limits manageable on your account's Limits page.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2070,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update_limits",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum monthly usage in USD."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2071,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_monthly_usage_usd",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Data retention period in days."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2072,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data_retention_days",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2073,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4090,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2055,
+ 2060,
+ 2066,
+ 2063,
+ 2069
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4090
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2054,
+ "module": "_resource_clients.user",
+ "name": "UserClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2075,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 156
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2080,
+ "module": "_resource_clients.user",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved user data, or None if the user does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 169
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved user data, or None if the user does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2081,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2082,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "UserPublicInfo | UserPrivateInfo | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "UserPublicInfo",
+ "target": "1413"
+ },
+ {
+ "type": "reference",
+ "name": "UserPrivateInfo",
+ "target": "1402"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2083,
+ "module": "_resource_clients.user",
+ "name": "monthly_usage",
+ "parsedDocstring": {
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved monthly usage."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 190
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved monthly usage."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2084,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "monthly_usage",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2085,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "MonthlyUsage",
+ "type": "reference",
+ "target": "792"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2086,
+ "module": "_resource_clients.user",
+ "name": "limits",
+ "parsedDocstring": {
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The account limits."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 217
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The account limits."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2087,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "limits",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2088,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AccountLimits",
+ "type": "reference",
+ "target": "187"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the account's limits manageable on your account's Limits page.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2089,
+ "module": "_resource_clients.user",
+ "name": "update_limits",
+ "parsedDocstring": {
+ "text": "Update the account's limits manageable on your account's Limits page.\n",
+ "args": {
+ "max_monthly_usage_usd": "Maximum monthly usage in USD.",
+ "data_retention_days": "Data retention period in days.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 243
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the account's limits manageable on your account's Limits page.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2090,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update_limits",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum monthly usage in USD."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2091,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_monthly_usage_usd",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Data retention period in days."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2092,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "data_retention_days",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2093,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4063,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2075,
+ 2080,
+ 2086,
+ 2083,
+ 2089
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4063
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2074,
+ "module": "_resource_clients.user",
+ "name": "UserClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/user.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 149
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize a new instance.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2095,
+ "module": "_resource_clients.request_queue",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize a new instance.\n",
+ "args": {
+ "client_key": "A unique identifier of the client accessing the request queue."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 70
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize a new instance.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2096,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2097,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "'request-queues'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2098,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier of the client accessing the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2099,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2100,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "kwargs",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2101,
+ "module": "_resource_clients.request_queue",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved request queue, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 90
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved request queue, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2102,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2103,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestQueue",
+ "target": "973"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2104,
+ "module": "_resource_clients.request_queue",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n",
+ "args": {
+ "name": "The new name for the request queue.",
+ "general_access": "Determines how others can access the request queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 106
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated request queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2105,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2106,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2107,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2108,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue",
+ "type": "reference",
+ "target": "973"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2109,
+ "module": "_resource_clients.request_queue",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 128
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2110,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2111,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2112,
+ "module": "_resource_clients.request_queue",
+ "name": "list_head",
+ "parsedDocstring": {
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n",
+ "args": {
+ "limit": "How many requests to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The desired number of requests from the beginning of the queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 138
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The desired number of requests from the beginning of the queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2113,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list_head",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2114,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2115,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueueHead",
+ "type": "reference",
+ "target": "990"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2116,
+ "module": "_resource_clients.request_queue",
+ "name": "list_and_lock_head",
+ "parsedDocstring": {
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n",
+ "args": {
+ "lock_duration": "How long the requests will be locked for.",
+ "limit": "How many requests to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The desired number of locked requests from the beginning of the queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 162
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The desired number of locked requests from the beginning of the queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2117,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list_and_lock_head",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the requests will be locked for."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2118,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "lock_duration",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2119,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2120,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "LockedRequestQueueHead",
+ "type": "reference",
+ "target": "777"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2121,
+ "module": "_resource_clients.request_queue",
+ "name": "add_request",
+ "parsedDocstring": {
+ "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n",
+ "args": {
+ "request": "The request to add to the queue.",
+ "forefront": "Whether to add the request to the head or the end of the queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The added request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 197
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The added request."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2122,
+ "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": 2123,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request",
+ "type": {
+ "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDict",
+ "target": "106"
+ },
+ {
+ "type": "reference",
+ "name": "RequestDraftCamelDict",
+ "target": "111"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to add the request to the head or the end of the queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2124,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2125,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2126,
+ "module": "_resource_clients.request_queue",
+ "name": "get_request",
+ "parsedDocstring": {
+ "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n",
+ "args": {
+ "request_id": "ID of the request to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved request, or None, if it did not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 232
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved request, or None, if it did not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2127,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_request",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2128,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2129,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Request | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2130,
+ "module": "_resource_clients.request_queue",
+ "name": "update_request",
+ "parsedDocstring": {
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n",
+ "args": {
+ "request": "The updated request.",
+ "forefront": "Whether to put the updated request in the beginning or the end of the queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 259
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated request."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2131,
+ "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": 2132,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request",
+ "type": {
+ "name": "RequestDict | RequestCamelDict | Request",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestDict",
+ "target": "102"
+ },
+ {
+ "type": "reference",
+ "name": "RequestCamelDict",
+ "target": "104"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the updated request in the beginning or the end of the queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2133,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2134,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2135,
+ "module": "_resource_clients.request_queue",
+ "name": "delete_request",
+ "parsedDocstring": {
+ "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n",
+ "args": {
+ "request_id": "ID of the request to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 294
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2136,
+ "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": 2137,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2138,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2139,
+ "module": "_resource_clients.request_queue",
+ "name": "prolong_request_lock",
+ "parsedDocstring": {
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n",
+ "args": {
+ "request_id": "ID of the request to prolong the lock.",
+ "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.",
+ "lock_duration": "By how much to prolong the lock.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 314
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2140,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "prolong_request_lock",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to prolong the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2141,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the request in the beginning or the end of the queue after lock expires."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2142,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By how much to prolong the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2143,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "lock_duration",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2144,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestLockInfo | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestLockInfo",
+ "target": "970"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2145,
+ "module": "_resource_clients.request_queue",
+ "name": "delete_request_lock",
+ "parsedDocstring": {
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n",
+ "args": {
+ "request_id": "ID of the request to delete the lock.",
+ "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 348
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2146,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete_request_lock",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to delete the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2147,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2148,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2149,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2150,
+ "module": "_resource_clients.request_queue",
+ "name": "batch_add_requests",
+ "parsedDocstring": {
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n",
+ "args": {
+ "requests": "List of requests to be added to the queue.",
+ "forefront": "Whether to add requests to the front of the queue.",
+ "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Result containing lists of processed and unprocessed requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 373
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Result containing lists of processed and unprocessed requests."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2151,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "batch_add_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of requests to be added to the queue."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2152,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "requests",
+ "type": {
+ "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDict",
+ "target": "106"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftCamelDict",
+ "target": "111"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to add requests to the front of the queue."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2153,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported."
+ }
+ ]
+ },
+ "defaultValue": "1",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2154,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_parallel",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2155,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BatchAddResult",
+ "type": "reference",
+ "target": "311"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2156,
+ "module": "_resource_clients.request_queue",
+ "name": "batch_delete_requests",
+ "parsedDocstring": {
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n",
+ "args": {
+ "requests": "List of the requests to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 454
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2157,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "batch_delete_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of the requests to delete."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2158,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "requests",
+ "type": {
+ "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDelete",
+ "target": "968"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2159,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BatchDeleteResult",
+ "type": "reference",
+ "target": "318"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2160,
+ "module": "_resource_clients.request_queue",
+ "name": "list_requests",
+ "parsedDocstring": {
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n",
+ "args": {
+ "limit": "How many requests to retrieve.",
+ "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.",
+ "timeout": "Timeout for the API HTTP request.",
+ "cursor": "A token returned in previous API response, to continue listing next page of requests"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 492
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2161,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2162,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of request states to use as a filter. Multiple values mean union of the given filters."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2163,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "filter",
+ "type": {
+ "name": "list[Literal['pending', 'locked']] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "pending"
+ },
+ {
+ "type": "literal",
+ "value": "locked"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2164,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A token returned in previous API response, to continue listing next page of requests"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2165,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRequests",
+ "type": "reference",
+ "target": "737"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2166,
+ "module": "_resource_clients.request_queue",
+ "name": "iterate_requests",
+ "parsedDocstring": {
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n",
+ "args": {
+ "limit": "Maximum number of requests to yield across all pages.",
+ "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.",
+ "cursor": "A token returned in a previous API response, used as the initial pagination cursor.",
+ "chunk_size": "Maximum number of requests requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 527
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2167,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of requests to yield across all pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2168,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of request states to use as a filter. Multiple values mean union of the given filters."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2169,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "filter",
+ "type": {
+ "name": "list[Literal['pending', 'locked']] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "pending"
+ },
+ {
+ "type": "literal",
+ "value": "locked"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A token returned in a previous API response, used as the initial pagination cursor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2170,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of requests requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2171,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2172,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2173,
+ "module": "_resource_clients.request_queue",
+ "name": "unlock_requests",
+ "parsedDocstring": {
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Result of the unlock operation containing the count of unlocked requests"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 565
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Result of the unlock operation containing the count of unlocked requests"
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2174,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "unlock_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2175,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "UnlockRequestsResult",
+ "type": "reference",
+ "target": "1341"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4091,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2095,
+ 2121,
+ 2150,
+ 2156,
+ 2109,
+ 2135,
+ 2145,
+ 2101,
+ 2126,
+ 2166,
+ 2116,
+ 2112,
+ 2160,
+ 2139,
+ 2173,
+ 2104,
+ 2130
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4091
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2094,
+ "module": "_resource_clients.request_queue",
+ "name": "RequestQueueClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize a new instance.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2177,
+ "module": "_resource_clients.request_queue",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize a new instance.\n",
+ "args": {
+ "client_key": "A unique identifier of the client accessing the request queue."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 597
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize a new instance.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2178,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2179,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "defaultValue": "'request-queues'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2180,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier of the client accessing the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2181,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2182,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "kwargs",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2183,
+ "module": "_resource_clients.request_queue",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved request queue, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 617
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved request queue, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2184,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2185,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestQueue",
+ "target": "973"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2186,
+ "module": "_resource_clients.request_queue",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n",
+ "args": {
+ "name": "The new name for the request queue.",
+ "general_access": "Determines how others can access the request queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated request queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2187,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2188,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the request queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2189,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2190,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue",
+ "type": "reference",
+ "target": "973"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2191,
+ "module": "_resource_clients.request_queue",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 655
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2192,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2193,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2194,
+ "module": "_resource_clients.request_queue",
+ "name": "list_head",
+ "parsedDocstring": {
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n",
+ "args": {
+ "limit": "How many requests to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The desired number of requests from the beginning of the queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 665
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The desired number of requests from the beginning of the queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2195,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list_head",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2196,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2197,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueueHead",
+ "type": "reference",
+ "target": "990"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2198,
+ "module": "_resource_clients.request_queue",
+ "name": "list_and_lock_head",
+ "parsedDocstring": {
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n",
+ "args": {
+ "lock_duration": "How long the requests will be locked for.",
+ "limit": "How many requests to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The desired number of locked requests from the beginning of the queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 689
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The desired number of locked requests from the beginning of the queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2199,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list_and_lock_head",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the requests will be locked for."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2200,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "lock_duration",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2201,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2202,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "LockedRequestQueueHead",
+ "type": "reference",
+ "target": "777"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2203,
+ "module": "_resource_clients.request_queue",
+ "name": "add_request",
+ "parsedDocstring": {
+ "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n",
+ "args": {
+ "request": "The request to add to the queue.",
+ "forefront": "Whether to add the request to the head or the end of the queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The added request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 724
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The added request."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2204,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "add_request",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The request to add to the queue."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2205,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request",
+ "type": {
+ "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDict",
+ "target": "106"
+ },
+ {
+ "type": "reference",
+ "name": "RequestDraftCamelDict",
+ "target": "111"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to add the request to the head or the end of the queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2206,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2207,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2208,
+ "module": "_resource_clients.request_queue",
+ "name": "get_request",
+ "parsedDocstring": {
+ "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n",
+ "args": {
+ "request_id": "ID of the request to retrieve.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved request, or None, if it did not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 759
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved request, or None, if it did not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2209,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_request",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2210,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2211,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Request | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2212,
+ "module": "_resource_clients.request_queue",
+ "name": "update_request",
+ "parsedDocstring": {
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n",
+ "args": {
+ "request": "The updated request.",
+ "forefront": "Whether to put the updated request in the beginning or the end of the queue.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 784
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated request."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2213,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update_request",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The updated request."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2214,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request",
+ "type": {
+ "name": "RequestDict | RequestCamelDict | Request",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestDict",
+ "target": "102"
+ },
+ {
+ "type": "reference",
+ "name": "RequestCamelDict",
+ "target": "104"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the updated request in the beginning or the end of the queue."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2215,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2216,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestRegistration",
+ "type": "reference",
+ "target": "1027"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2217,
+ "module": "_resource_clients.request_queue",
+ "name": "delete_request",
+ "parsedDocstring": {
+ "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n",
+ "args": {
+ "request_id": "ID of the request to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 819
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2218,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete_request",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to delete."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2219,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2220,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2221,
+ "module": "_resource_clients.request_queue",
+ "name": "prolong_request_lock",
+ "parsedDocstring": {
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n",
+ "args": {
+ "request_id": "ID of the request to prolong the lock.",
+ "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.",
+ "lock_duration": "By how much to prolong the lock.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 837
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2222,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "prolong_request_lock",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to prolong the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2223,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the request in the beginning or the end of the queue after lock expires."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2224,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By how much to prolong the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2225,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "lock_duration",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2226,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestLockInfo | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RequestLockInfo",
+ "target": "970"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2227,
+ "module": "_resource_clients.request_queue",
+ "name": "delete_request_lock",
+ "parsedDocstring": {
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n",
+ "args": {
+ "request_id": "ID of the request to delete the lock.",
+ "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 871
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2228,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete_request_lock",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the request to delete the lock."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2229,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2230,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2231,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2232,
+ "module": "_resource_clients.request_queue",
+ "name": "batch_add_requests",
+ "parsedDocstring": {
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n",
+ "args": {
+ "requests": "List of requests to be added to the queue.",
+ "forefront": "Whether to add requests to the front of the queue.",
+ "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Result containing lists of processed and unprocessed requests."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 945
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Result containing lists of processed and unprocessed requests."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2233,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "batch_add_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of requests to be added to the queue."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2234,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "requests",
+ "type": {
+ "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraft",
+ "target": "954"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDict",
+ "target": "106"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftCamelDict",
+ "target": "111"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to add requests to the front of the queue."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2235,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "forefront",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported."
+ }
+ ]
+ },
+ "defaultValue": "5",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2236,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_parallel",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2237,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BatchAddResult",
+ "type": "reference",
+ "target": "311"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2238,
+ "module": "_resource_clients.request_queue",
+ "name": "batch_delete_requests",
+ "parsedDocstring": {
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n",
+ "args": {
+ "requests": "List of the requests to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1037
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2239,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "batch_delete_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of the requests to delete."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2240,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "requests",
+ "type": {
+ "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDelete",
+ "target": "968"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2241,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BatchDeleteResult",
+ "type": "reference",
+ "target": "318"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2242,
+ "module": "_resource_clients.request_queue",
+ "name": "list_requests",
+ "parsedDocstring": {
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n",
+ "args": {
+ "limit": "How many requests to retrieve.",
+ "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.",
+ "timeout": "Timeout for the API HTTP request.",
+ "cursor": "A token returned in previous API response, to continue listing next page of requests"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1074
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2243,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many requests to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2244,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of request states to use as a filter. Multiple values mean union of the given filters."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2245,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "filter",
+ "type": {
+ "name": "list[Literal['pending', 'locked']] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "pending"
+ },
+ {
+ "type": "literal",
+ "value": "locked"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2246,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A token returned in previous API response, to continue listing next page of requests"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2247,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRequests",
+ "type": "reference",
+ "target": "737"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2248,
+ "module": "_resource_clients.request_queue",
+ "name": "iterate_requests",
+ "parsedDocstring": {
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n",
+ "args": {
+ "limit": "Maximum number of requests to yield across all pages.",
+ "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.",
+ "cursor": "A token returned in a previous API response, used as the initial pagination cursor.",
+ "chunk_size": "Maximum number of requests requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2249,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of requests to yield across all pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2250,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of request states to use as a filter. Multiple values mean union of the given filters."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2251,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "filter",
+ "type": {
+ "name": "list[Literal['pending', 'locked']] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "pending"
+ },
+ {
+ "type": "literal",
+ "value": "locked"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A token returned in a previous API response, used as the initial pagination cursor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2252,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "cursor",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of requests requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2253,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2254,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Request",
+ "target": "951"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2255,
+ "module": "_resource_clients.request_queue",
+ "name": "unlock_requests",
+ "parsedDocstring": {
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Result of the unlock operation containing the count of unlocked requests"
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1147
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Result of the unlock operation containing the count of unlocked requests"
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2256,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "unlock_requests",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2257,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "UnlockRequestsResult",
+ "type": "reference",
+ "target": "1341"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4064,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2177,
+ 2203,
+ 2232,
+ 2238,
+ 2191,
+ 2217,
+ 2227,
+ 2183,
+ 2208,
+ 2248,
+ 2198,
+ 2194,
+ 2242,
+ 2221,
+ 2255,
+ 2186,
+ 2212
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4064
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2176,
+ "module": "_resource_clients.request_queue",
+ "name": "RequestQueueClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 590
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2259,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2263,
+ "module": "_resource_clients.log",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2264,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2265,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2266,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2267,
+ "module": "_resource_clients.log",
+ "name": "get_as_bytes",
+ "parsedDocstring": {
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log as raw bytes, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log as raw bytes, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2268,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2269,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2270,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bytes | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bytes"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "contextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 2271,
+ "module": "_resource_clients.log",
+ "name": "stream",
+ "parsedDocstring": {
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 95
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2272,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "stream",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2273,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2274,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpResponse",
+ "target": "1903"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4092,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2259,
+ 2263,
+ 2267,
+ 2271
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4092
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2258,
+ "module": "_resource_clients.log",
+ "name": "LogClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 19
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2276,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 134
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2280,
+ "module": "_resource_clients.log",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 145
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2281,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2282,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2283,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2284,
+ "module": "_resource_clients.log",
+ "name": "get_as_bytes",
+ "parsedDocstring": {
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log as raw bytes, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 175
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log as raw bytes, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2285,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2286,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2287,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bytes | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bytes"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "asynccontextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 2288,
+ "module": "_resource_clients.log",
+ "name": "stream",
+ "parsedDocstring": {
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n",
+ "args": {
+ "raw": "If true, the log will include formatting. For example, coloring character sequences.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 203
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2289,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "stream",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the log will include formatting. For example, coloring character sequences."
+ }
+ ]
+ },
+ "defaultValue": "False",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2290,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "raw",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2291,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "HttpResponse",
+ "target": "1903"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4065,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2276,
+ 2280,
+ 2284,
+ 2288
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4065
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2275,
+ "module": "_resource_clients.log",
+ "name": "LogClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/log.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 127
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2293,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 23
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2297,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actor environment variables."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 34
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actor environment variables."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2298,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2299,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfEnvVars",
+ "type": "reference",
+ "target": "713"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2300,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 48
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2301,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2302,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2303,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n",
+ "args": {
+ "is_secret": "Whether the environment variable is secret or not.",
+ "name": "The name of the environment variable.",
+ "value": "The value of the environment variable.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 66
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2304,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variable is secret or not."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2305,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_secret",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2306,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The value of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2307,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2308,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar",
+ "type": "reference",
+ "target": "592"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4093,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2293,
+ 2303,
+ 2300,
+ 2297
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4093
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2292,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "ActorEnvVarCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 16
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2310,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 102
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2314,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actor environment variables."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 113
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actor environment variables."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2315,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2316,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfEnvVars",
+ "type": "reference",
+ "target": "713"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2317,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 127
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2318,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2319,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2320,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n",
+ "args": {
+ "is_secret": "Whether the environment variable is secret or not.",
+ "name": "The name of the environment variable.",
+ "value": "The value of the environment variable.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 146
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2321,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variable is secret or not."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2322,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_secret",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2323,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The value of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2324,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2325,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar",
+ "type": "reference",
+ "target": "592"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4066,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2310,
+ 2320,
+ 2317,
+ 2314
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4066
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2309,
+ "module": "_resource_clients.actor_env_var_collection",
+ "name": "ActorEnvVarCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 95
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2327,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2331,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n",
+ "args": {
+ "limit": "How many webhook dispatches to retrieve.",
+ "offset": "What webhook dispatch to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook dispatches of a user."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook dispatches of a user."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2332,
+ "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": 2333,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook dispatch to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2334,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2335,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2336,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhookDispatches",
+ "type": "reference",
+ "target": "842"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2337,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n",
+ "args": {
+ "limit": "How many webhook dispatches to retrieve.",
+ "offset": "What webhook dispatch to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 60
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2338,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhook dispatches to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2339,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook dispatch to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2340,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2341,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2342,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatch",
+ "target": "1474"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4094,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2327,
+ 2337,
+ 2331
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4094
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2326,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "WebhookDispatchCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 18
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2344,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 99
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2348,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n",
+ "args": {
+ "limit": "How many webhook dispatches to retrieve.",
+ "offset": "What webhook dispatch to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook dispatches of a user."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 110
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook dispatches of a user."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2349,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhook dispatches to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2350,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook dispatch to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2351,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2352,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2353,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhookDispatches",
+ "type": "reference",
+ "target": "842"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2354,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n",
+ "args": {
+ "limit": "How many webhook dispatches to retrieve.",
+ "offset": "What webhook dispatch to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 134
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2355,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhook dispatches to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2356,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook dispatch to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2357,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2358,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2359,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatch",
+ "target": "1474"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4067,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2344,
+ 2354,
+ 2348
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4067
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2343,
+ "module": "_resource_clients.webhook_dispatch_collection",
+ "name": "WebhookDispatchCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 92
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2361,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2365,
+ "module": "_resource_clients.actor_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n",
+ "args": {
+ "my": "If True, will return only Actors which the user has created themselves.",
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "desc": "Whether to sort the Actors in descending order based on their creation date.",
+ "sort_by": "Field to sort the results by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actors matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 47
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actors matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2366,
+ "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": 2367,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "my",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2368,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2369,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the Actors in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2370,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Field to sort the results by."
+ }
+ ]
+ },
+ "defaultValue": "'createdAt'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2371,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "createdAt"
+ },
+ {
+ "type": "literal",
+ "value": "stats.lastRunStartedAt"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2372,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfActors",
+ "type": "reference",
+ "target": "812"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2373,
+ "module": "_resource_clients.actor_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n",
+ "args": {
+ "my": "If True, will return only Actors which the user has created themselves.",
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "desc": "Whether to sort the Actors in descending order based on their creation date.",
+ "sort_by": "Field to sort the results by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 75
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2374,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, will return only Actors which the user has created themselves."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2375,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "my",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2376,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2377,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the Actors in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2378,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Field to sort the results by."
+ }
+ ]
+ },
+ "defaultValue": "'createdAt'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2379,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "createdAt"
+ },
+ {
+ "type": "literal",
+ "value": "stats.lastRunStartedAt"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2380,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorShort",
+ "target": "266"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2381,
+ "module": "_resource_clients.actor_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n",
+ "args": {
+ "name": "The name of the Actor.",
+ "title": "The title of the Actor (human-readable).",
+ "description": "The description for the Actor.",
+ "seo_title": "The title of the Actor optimized for search engines.",
+ "seo_description": "The description of the Actor optimized for search engines.",
+ "versions": "The list of Actor versions.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "is_public": "Whether the Actor is public.",
+ "is_deprecated": "Whether the Actor is deprecated.",
+ "categories": "The categories to which the Actor belongs to.",
+ "default_run_build": "Tag or number of the build that you want to run by default.",
+ "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.",
+ "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.",
+ "default_run_timeout": "Default timeout for the runs of this Actor.",
+ "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.",
+ "example_run_input_content_type": "The content type of the example run input.",
+ "actor_standby_is_enabled": "Whether the Actor Standby is enabled.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2382,
+ "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": 2383,
+ "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": 2384,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2385,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2386,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2387,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The list of Actor versions."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2388,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "versions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2389,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is public."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2390,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_public",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is deprecated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2391,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_deprecated",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The categories to which the Actor belongs to."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2392,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "categories",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag or number of the build that you want to run by default."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2393,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2394,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default amount of memory allocated for the runs of this Actor, in megabytes."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2395,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for the runs of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2396,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Input to be prefilled as default input to new users of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2397,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_body",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the example run input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2398,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor Standby is enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2399,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2400,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2401,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2402,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2403,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2404,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2405,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor",
+ "type": "reference",
+ "target": "199"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4095,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2361,
+ 2381,
+ 2373,
+ 2365
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4095
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2360,
+ "module": "_resource_clients.actor_collection",
+ "name": "ActorCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2407,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 215
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2411,
+ "module": "_resource_clients.actor_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n",
+ "args": {
+ "my": "If True, will return only Actors which the user has created themselves.",
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "desc": "Whether to sort the Actors in descending order based on their creation date.",
+ "sort_by": "Field to sort the results by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actors matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 226
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actors matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2412,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, will return only Actors which the user has created themselves."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2413,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "my",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2414,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2415,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the Actors in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2416,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Field to sort the results by."
+ }
+ ]
+ },
+ "defaultValue": "'createdAt'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2417,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "createdAt"
+ },
+ {
+ "type": "literal",
+ "value": "stats.lastRunStartedAt"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2418,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfActors",
+ "type": "reference",
+ "target": "812"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2419,
+ "module": "_resource_clients.actor_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n",
+ "args": {
+ "my": "If True, will return only Actors which the user has created themselves.",
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "desc": "Whether to sort the Actors in descending order based on their creation date.",
+ "sort_by": "Field to sort the results by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 254
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2420,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, will return only Actors which the user has created themselves."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2421,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "my",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2422,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2423,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the Actors in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2424,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Field to sort the results by."
+ }
+ ]
+ },
+ "defaultValue": "'createdAt'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2425,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "createdAt"
+ },
+ {
+ "type": "literal",
+ "value": "stats.lastRunStartedAt"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2426,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorShort",
+ "target": "266"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2427,
+ "module": "_resource_clients.actor_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n",
+ "args": {
+ "name": "The name of the Actor.",
+ "title": "The title of the Actor (human-readable).",
+ "description": "The description for the Actor.",
+ "seo_title": "The title of the Actor optimized for search engines.",
+ "seo_description": "The description of the Actor optimized for search engines.",
+ "versions": "The list of Actor versions.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "is_public": "Whether the Actor is public.",
+ "is_deprecated": "Whether the Actor is deprecated.",
+ "categories": "The categories to which the Actor belongs to.",
+ "default_run_build": "Tag or number of the build that you want to run by default.",
+ "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.",
+ "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.",
+ "default_run_timeout": "Default timeout for the runs of this Actor.",
+ "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.",
+ "example_run_input_content_type": "The content type of the example run input.",
+ "actor_standby_is_enabled": "Whether the Actor Standby is enabled.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 288
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2428,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the Actor."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2429,
+ "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": 2430,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2431,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2432,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2433,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The list of Actor versions."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2434,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "versions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2435,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is public."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2436,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_public",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is deprecated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2437,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_deprecated",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The categories to which the Actor belongs to."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2438,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "categories",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag or number of the build that you want to run by default."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2439,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2440,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default amount of memory allocated for the runs of this Actor, in megabytes."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2441,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for the runs of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2442,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Input to be prefilled as default input to new users of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2443,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_body",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the example run input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2444,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor Standby is enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2445,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2446,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2447,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2448,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2449,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2450,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2451,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor",
+ "type": "reference",
+ "target": "199"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4068,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2407,
+ 2427,
+ 2419,
+ 2411
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4068
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2406,
+ "module": "_resource_clients.actor_collection",
+ "name": "ActorCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 208
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2453,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2458,
+ "module": "_resource_clients.webhook_dispatch",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook dispatch, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 34
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook dispatch, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2459,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2460,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatch",
+ "target": "1474"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4096,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2453,
+ 2458
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4096
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2452,
+ "module": "_resource_clients.webhook_dispatch",
+ "name": "WebhookDispatchClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 14
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2462,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 59
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2467,
+ "module": "_resource_clients.webhook_dispatch",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook dispatch, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook dispatch, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2468,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2469,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhookDispatch",
+ "target": "1474"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4069,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2462,
+ 2467
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4069
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2461,
+ "module": "_resource_clients.webhook_dispatch",
+ "name": "WebhookDispatchClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 52
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2471,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 30
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2475,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n",
+ "args": {
+ "unnamed": "Whether to include unnamed key-value stores in the list.",
+ "limit": "How many key-value stores to retrieve.",
+ "offset": "What key-value store to include as first when retrieving the list.",
+ "desc": "Whether to sort the key-value stores in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available key-value stores matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 41
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available key-value stores matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2476,
+ "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": 2477,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many key-value stores to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2478,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What key-value store to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2479,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the key-value stores in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2480,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2481,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2482,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfKeyValueStores",
+ "type": "reference",
+ "target": "822"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2483,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n",
+ "args": {
+ "unnamed": "Whether to include unnamed key-value stores in the list.",
+ "limit": "How many key-value stores to retrieve.",
+ "offset": "What key-value store to include as first when retrieving the list.",
+ "desc": "Whether to sort the key-value stores in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 77
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed key-value stores in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many key-value stores to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What key-value store to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the key-value stores in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStore",
+ "target": "647"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2491,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n",
+ "args": {
+ "name": "The name of the key-value store to retrieve or create.",
+ "schema": "The schema of the key-value store.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 114
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created key-value store."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2492,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the key-value store to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2493,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The schema of the key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2494,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schema",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore",
+ "type": "reference",
+ "target": "647"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4097,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2471,
+ 2491,
+ 2483,
+ 2475
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4097
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2470,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "KeyValueStoreCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 23
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2497,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 145
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2501,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n",
+ "args": {
+ "unnamed": "Whether to include unnamed key-value stores in the list.",
+ "limit": "How many key-value stores to retrieve.",
+ "offset": "What key-value store to include as first when retrieving the list.",
+ "desc": "Whether to sort the key-value stores in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available key-value stores matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 156
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available key-value stores matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2502,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed key-value stores in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2503,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many key-value stores to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2504,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What key-value store to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2505,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the key-value stores in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2506,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2507,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2508,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfKeyValueStores",
+ "type": "reference",
+ "target": "822"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2509,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n",
+ "args": {
+ "unnamed": "Whether to include unnamed key-value stores in the list.",
+ "limit": "How many key-value stores to retrieve.",
+ "offset": "What key-value store to include as first when retrieving the list.",
+ "desc": "Whether to sort the key-value stores in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 192
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2510,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed key-value stores in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2511,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many key-value stores to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2512,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What key-value store to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2513,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the key-value stores in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2514,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2515,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2516,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStore",
+ "target": "647"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2517,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n",
+ "args": {
+ "name": "The name of the key-value store to retrieve or create.",
+ "schema": "The schema of the key-value store.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 229
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created key-value store."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2518,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the key-value store to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2519,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The schema of the key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2520,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schema",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2521,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore",
+ "type": "reference",
+ "target": "647"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4070,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2497,
+ 2517,
+ 2509,
+ 2501
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4070
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2496,
+ "module": "_resource_clients.key_value_store_collection",
+ "name": "KeyValueStoreCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 138
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2523,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 39
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2528,
+ "module": "_resource_clients.actor_version",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor version data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 52
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor version data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2529,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2530,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2531,
+ "module": "_resource_clients.actor_version",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n",
+ "args": {
+ "build_tag": "Tag that is automatically set to the latest successful build of the current version.",
+ "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.",
+ "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.",
+ "source_type": "What source type is the Actor version using.",
+ "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.",
+ "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.",
+ "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.",
+ "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 68
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2532,
+ "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": 2533,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2534,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_vars",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2535,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "apply_env_vars_to_build",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What source type is the Actor version using."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2536,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_type",
+ "type": {
+ "name": "VersionSourceType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "VersionSourceType",
+ "target": "1900"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2537,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_files",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2538,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "git_repo_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2539,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tarball_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2540,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "github_gist_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2541,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version",
+ "type": "reference",
+ "target": "1424"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2542,
+ "module": "_resource_clients.actor_version",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 118
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2543,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2544,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2545,
+ "module": "_resource_clients.actor_version",
+ "name": "env_vars",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 128
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2546,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "env_vars",
+ "parameters": [],
+ "type": {
+ "name": "ActorEnvVarCollectionClient",
+ "type": "reference",
+ "target": "2292"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2547,
+ "module": "_resource_clients.actor_version",
+ "name": "env_var",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n",
+ "args": {
+ "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n"
+ },
+ "returns": "The resource client for the specified Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 132
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the specified Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2548,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "env_var",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable for which to retrieve the resource client.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2549,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_var_name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorEnvVarClient",
+ "type": "reference",
+ "target": "3856"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4098,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2523,
+ 2542,
+ 2547,
+ 2545,
+ 2528,
+ 2531
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4098
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2522,
+ "module": "_resource_clients.actor_version",
+ "name": "ActorVersionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2551,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 155
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2556,
+ "module": "_resource_clients.actor_version",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor version data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 168
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor version data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2557,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2558,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2559,
+ "module": "_resource_clients.actor_version",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n",
+ "args": {
+ "build_tag": "Tag that is automatically set to the latest successful build of the current version.",
+ "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.",
+ "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.",
+ "source_type": "What source type is the Actor version using.",
+ "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.",
+ "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.",
+ "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.",
+ "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 184
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2560,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag that is automatically set to the latest successful build of the current version."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2561,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2562,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_vars",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2563,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "apply_env_vars_to_build",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What source type is the Actor version using."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2564,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_type",
+ "type": {
+ "name": "VersionSourceType | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "VersionSourceType",
+ "target": "1900"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2565,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_files",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2566,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "git_repo_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2567,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tarball_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2568,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "github_gist_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2569,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version",
+ "type": "reference",
+ "target": "1424"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2570,
+ "module": "_resource_clients.actor_version",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 234
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2571,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2572,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2573,
+ "module": "_resource_clients.actor_version",
+ "name": "env_vars",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 244
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the environment variables of this Actor version."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2574,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "env_vars",
+ "parameters": [],
+ "type": {
+ "name": "ActorEnvVarCollectionClientAsync",
+ "type": "reference",
+ "target": "2309"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2575,
+ "module": "_resource_clients.actor_version",
+ "name": "env_var",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n",
+ "args": {
+ "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n"
+ },
+ "returns": "The resource client for the specified Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 248
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the specified Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified environment variable of this Actor version.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2576,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "env_var",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable for which to retrieve the resource client.\n"
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 2577,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_var_name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorEnvVarClientAsync",
+ "type": "reference",
+ "target": "3874"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4071,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2551,
+ 2570,
+ 2575,
+ 2573,
+ 2556,
+ 2559
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4071
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2550,
+ "module": "_resource_clients.actor_version",
+ "name": "ActorVersionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 148
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2579,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2583,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n",
+ "args": {
+ "unnamed": "Whether to include unnamed request queues in the list.",
+ "limit": "How many request queues to retrieve.",
+ "offset": "What request queue to include as first when retrieving the list.",
+ "desc": "Whether to sort the request queues in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available request queues matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available request queues matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2584,
+ "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": 2585,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many request queues to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2586,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What request queue to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2587,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the request queues in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2588,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2589,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2590,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRequestQueues",
+ "type": "reference",
+ "target": "826"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2591,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n",
+ "args": {
+ "unnamed": "Whether to include unnamed request queues in the list.",
+ "limit": "How many request queues to retrieve.",
+ "offset": "What request queue to include as first when retrieving the list.",
+ "desc": "Whether to sort the request queues in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 78
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2592,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed request queues in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2593,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many request queues to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2594,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What request queue to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2595,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the request queues in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2596,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2597,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2598,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueShort",
+ "target": "999"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2599,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n",
+ "args": {
+ "name": "The name of the request queue to retrieve or create.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created request queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2600,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the request queue to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2601,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2602,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue",
+ "type": "reference",
+ "target": "973"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4099,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2579,
+ 2599,
+ 2591,
+ 2583
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4099
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2578,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "RequestQueueCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 24
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2604,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 144
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2608,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n",
+ "args": {
+ "unnamed": "Whether to include unnamed request queues in the list.",
+ "limit": "How many request queues to retrieve.",
+ "offset": "What request queue to include as first when retrieving the list.",
+ "desc": "Whether to sort the request queues in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available request queues matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 155
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available request queues matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2609,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed request queues in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2610,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many request queues to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2611,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What request queue to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2612,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the request queues in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2613,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2614,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2615,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRequestQueues",
+ "type": "reference",
+ "target": "826"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2616,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n",
+ "args": {
+ "unnamed": "Whether to include unnamed request queues in the list.",
+ "limit": "How many request queues to retrieve.",
+ "offset": "What request queue to include as first when retrieving the list.",
+ "desc": "Whether to sort the request queues in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 191
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2617,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed request queues in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2618,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many request queues to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2619,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What request queue to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2620,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the request queues in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2621,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2622,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2623,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RequestQueueShort",
+ "target": "999"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2624,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n",
+ "args": {
+ "name": "The name of the request queue to retrieve or create.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created request queue."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 228
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created request queue."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2625,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the request queue to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2626,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2627,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "RequestQueue",
+ "type": "reference",
+ "target": "973"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4072,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2604,
+ 2624,
+ 2616,
+ 2608
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4072
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2603,
+ "module": "_resource_clients.request_queue_collection",
+ "name": "RequestQueueCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 137
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2629,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2633,
+ "module": "_resource_clients.task_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n",
+ "args": {
+ "limit": "How many tasks to list.",
+ "offset": "What task to include as first when retrieving the list.",
+ "desc": "Whether to sort the tasks in descending order based on their creation date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available tasks matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 48
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available tasks matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2634,
+ "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": 2635,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What task to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2636,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the tasks in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2637,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2638,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfTasks",
+ "type": "reference",
+ "target": "839"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2639,
+ "module": "_resource_clients.task_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n",
+ "args": {
+ "limit": "How many tasks to list.",
+ "offset": "What task to include as first when retrieving the list.",
+ "desc": "Whether to sort the tasks in descending order based on their creation date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2640,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many tasks to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2641,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What task to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2642,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the tasks in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2643,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2644,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskShort",
+ "target": "1314"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2645,
+ "module": "_resource_clients.task_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n",
+ "args": {
+ "actor_id": "Id of the Actor that should be run.",
+ "name": "Name of the task.",
+ "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "task_input": "Task input object.",
+ "title": "A human-friendly equivalent of the name.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 102
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2646,
+ "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": 2647,
+ "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": 2648,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2649,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2650,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2651,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2652,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2653,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input object."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2654,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2655,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2656,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2657,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2658,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2659,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2660,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2661,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4100,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2629,
+ 2645,
+ 2639,
+ 2633
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4100
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2628,
+ "module": "_resource_clients.task_collection",
+ "name": "TaskCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 30
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2663,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 188
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2667,
+ "module": "_resource_clients.task_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n",
+ "args": {
+ "limit": "How many tasks to list.",
+ "offset": "What task to include as first when retrieving the list.",
+ "desc": "Whether to sort the tasks in descending order based on their creation date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available tasks matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 199
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available tasks matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2668,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many tasks to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2669,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What task to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2670,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the tasks in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2671,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2672,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfTasks",
+ "type": "reference",
+ "target": "839"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2673,
+ "module": "_resource_clients.task_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n",
+ "args": {
+ "limit": "How many tasks to list.",
+ "offset": "What task to include as first when retrieving the list.",
+ "desc": "Whether to sort the tasks in descending order based on their creation date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 223
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2674,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many tasks to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2675,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What task to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2676,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the tasks in descending order based on their creation date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2677,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2678,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "TaskShort",
+ "target": "1314"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 2679,
+ "module": "_resource_clients.task_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n",
+ "args": {
+ "actor_id": "Id of the Actor that should be run.",
+ "name": "Name of the task.",
+ "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "task_input": "Task input object.",
+ "title": "A human-friendly equivalent of the name.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 253
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2680,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor that should be run."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2681,
+ "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": 2682,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2683,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2684,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2685,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2686,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2687,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input object."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2688,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2689,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2690,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2691,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2692,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2693,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2694,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2695,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4073,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2663,
+ 2679,
+ 2673,
+ 2667
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4073
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2662,
+ "module": "_resource_clients.task_collection",
+ "name": "TaskCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 181
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2697,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2701,
+ "module": "_resource_clients.store_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n",
+ "args": {
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.",
+ "sort_by": "Specifies the field by which to sort the results.",
+ "category": "Filter by this category.",
+ "username": "Filter by this username.",
+ "pricing_model": "Filter by this pricing model.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actors matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actors matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2702,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2703,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2704,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2705,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "search",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the field by which to sort the results."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2706,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this category."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2707,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "category",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this username."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2708,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "username",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this pricing model."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2709,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_model",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2710,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfStoreActors",
+ "type": "reference",
+ "target": "836"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2711,
+ "module": "_resource_clients.store_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n",
+ "args": {
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.",
+ "sort_by": "Specifies the field by which to sort the results.",
+ "category": "Filter by this category.",
+ "username": "Filter by this username.",
+ "pricing_model": "Filter by this pricing model.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 78
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2712,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2713,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2714,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2715,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "search",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the field by which to sort the results."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2716,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this category."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2717,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "category",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this username."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2718,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "username",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this pricing model."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2719,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_model",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2720,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "StoreListActor",
+ "target": "1258"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4101,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2697,
+ 2711,
+ 2701
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4101
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2696,
+ "module": "_resource_clients.store_collection",
+ "name": "StoreCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 18
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2722,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 135
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2726,
+ "module": "_resource_clients.store_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n",
+ "args": {
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.",
+ "sort_by": "Specifies the field by which to sort the results.",
+ "category": "Filter by this category.",
+ "username": "Filter by this username.",
+ "pricing_model": "Filter by this pricing model.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actors matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 146
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actors matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2727,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2728,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2729,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2730,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "search",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the field by which to sort the results."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2731,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this category."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2732,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "category",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this username."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2733,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "username",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this pricing model."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2734,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_model",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2735,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfStoreActors",
+ "type": "reference",
+ "target": "836"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2736,
+ "module": "_resource_clients.store_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n",
+ "args": {
+ "limit": "How many Actors to list.",
+ "offset": "What Actor to include as first when retrieving the list.",
+ "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.",
+ "sort_by": "Specifies the field by which to sort the results.",
+ "category": "Filter by this category.",
+ "username": "Filter by this username.",
+ "pricing_model": "Filter by this pricing model.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 188
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2737,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many Actors to list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2738,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What Actor to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2739,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2740,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "search",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the field by which to sort the results."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2741,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "sort_by",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this category."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2742,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "category",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this username."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2743,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "username",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by this pricing model."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2744,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_model",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2745,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "StoreListActor",
+ "target": "1258"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4074,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2722,
+ 2736,
+ 2726
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4074
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2721,
+ "module": "_resource_clients.store_collection",
+ "name": "StoreCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/store_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 128
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2747,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 43
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2752,
+ "module": "_resource_clients.task",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 52
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2753,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2754,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Task",
+ "target": "1285"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2755,
+ "module": "_resource_clients.task",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n",
+ "args": {
+ "name": "Name of the task.",
+ "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "task_input": "Task input dictionary.",
+ "title": "A human-friendly equivalent of the name.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 68
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2756,
+ "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": 2757,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input dictionary."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2758,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2759,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2760,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2761,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2762,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2763,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2764,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2765,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2766,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2767,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2768,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2769,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2770,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2771,
+ "module": "_resource_clients.task",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 142
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2772,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2773,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2774,
+ "module": "_resource_clients.task",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n",
+ "args": {
+ "task_input": "Task input dictionary.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.",
+ "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 152
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2775,
+ "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": 2776,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2777,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2778,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2779,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2780,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2781,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2782,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2783,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2784,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2785,
+ "module": "_resource_clients.task",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n",
+ "args": {
+ "task_input": "Task input dictionary.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.",
+ "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 220
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2786,
+ "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": 2787,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2788,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2789,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2790,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2791,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2792,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2793,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2794,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2795,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2796,
+ "module": "_resource_clients.task",
+ "name": "get_input",
+ "parsedDocstring": {
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Retrieved task input."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 281
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Retrieved task input."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2797,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2798,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2799,
+ "module": "_resource_clients.task",
+ "name": "update_input",
+ "parsedDocstring": {
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n",
+ "args": {
+ "task_input": "The new default input for this task.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated task input."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 303
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated task input."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2800,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new default input for this task."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2801,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2802,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2803,
+ "module": "_resource_clients.task",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the runs of this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 327
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2804,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClient",
+ "type": "reference",
+ "target": "4014"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2805,
+ "module": "_resource_clients.task",
+ "name": "last_run",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n",
+ "args": {
+ "status": "Consider only runs with this status.",
+ "origin": "Consider only runs started with this origin.\n"
+ },
+ "returns": "The resource client for the last run of this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 334
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the last run of this task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2806,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "last_run",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs with this status."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2807,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs started with this origin.\n"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2808,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "origin",
+ "type": {
+ "name": "RunOrigin | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunOrigin",
+ "target": "1897"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClient",
+ "type": "reference",
+ "target": "3131"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2809,
+ "module": "_resource_clients.task",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Retrieve a client for webhooks associated with this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 353
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2810,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClient",
+ "type": "reference",
+ "target": "3892"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4102,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2747,
+ 2785,
+ 2771,
+ 2752,
+ 2796,
+ 2805,
+ 2803,
+ 2774,
+ 2755,
+ 2799,
+ 2809
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4102
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2746,
+ "module": "_resource_clients.task",
+ "name": "TaskClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2812,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 366
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 2817,
+ "module": "_resource_clients.task",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 375
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2818,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2819,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Task",
+ "target": "1285"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2820,
+ "module": "_resource_clients.task",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n",
+ "args": {
+ "name": "Name of the task.",
+ "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "task_input": "Task input dictionary.",
+ "title": "A human-friendly equivalent of the name.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 391
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2821,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the task."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2822,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input dictionary."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2823,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2824,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2825,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2826,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2827,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2828,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A human-friendly equivalent of the name."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2829,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2830,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2831,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2832,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2833,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2834,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2835,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Task",
+ "type": "reference",
+ "target": "1285"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2836,
+ "module": "_resource_clients.task",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 465
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2837,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2838,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2839,
+ "module": "_resource_clients.task",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n",
+ "args": {
+ "task_input": "Task input dictionary.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.",
+ "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 475
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2840,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "start",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input dictionary."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2841,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2842,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2843,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2844,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2845,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2846,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2847,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2848,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2849,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2850,
+ "module": "_resource_clients.task",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n",
+ "args": {
+ "task_input": "Task input dictionary.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.",
+ "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.",
+ "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.",
+ "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 543
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2851,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Task input dictionary."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2852,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2853,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2854,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2855,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2856,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2857,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2858,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2859,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2860,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2861,
+ "module": "_resource_clients.task",
+ "name": "get_input",
+ "parsedDocstring": {
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "Retrieved task input."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 603
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "Retrieved task input."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2862,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2863,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2864,
+ "module": "_resource_clients.task",
+ "name": "update_input",
+ "parsedDocstring": {
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n",
+ "args": {
+ "task_input": "The new default input for this task.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated task input."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 625
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated task input."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2865,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new default input for this task."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 2866,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "task_input",
+ "type": {
+ "name": "TaskInputDict | TaskInput",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict[str, Any]"
+ },
+ {
+ "type": "reference",
+ "name": "TaskInput",
+ "target": "1301"
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2867,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2868,
+ "module": "_resource_clients.task",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the runs of this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 649
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2869,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClientAsync",
+ "type": "reference",
+ "target": "4037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 2870,
+ "module": "_resource_clients.task",
+ "name": "last_run",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n",
+ "args": {
+ "status": "Consider only runs with this status.",
+ "origin": "Consider only runs started with this origin.\n"
+ },
+ "returns": "The resource client for the last run of this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 656
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the last run of this task."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2871,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "last_run",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs with this status."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2872,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs started with this origin.\n"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2873,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "origin",
+ "type": {
+ "name": "RunOrigin | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunOrigin",
+ "target": "1897"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClientAsync",
+ "type": "reference",
+ "target": "3200"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this task."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2874,
+ "module": "_resource_clients.task",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Retrieve a client for webhooks associated with this task."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 675
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this task."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2875,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClientAsync",
+ "type": "reference",
+ "target": "3923"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4075,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2812,
+ 2850,
+ 2836,
+ 2817,
+ 2861,
+ 2870,
+ 2868,
+ 2839,
+ 2820,
+ 2864,
+ 2874
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4075
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2811,
+ "module": "_resource_clients.task",
+ "name": "TaskClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/task.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 359
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2877,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2881,
+ "module": "_resource_clients.build_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n",
+ "args": {
+ "limit": "How many builds to retrieve.",
+ "offset": "What build to include as first when retrieving the list.",
+ "desc": "Whether to sort the builds in descending order based on their start date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor builds."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 36
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor builds."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2882,
+ "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": 2883,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What build to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2884,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the builds in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2885,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2886,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfBuilds",
+ "type": "reference",
+ "target": "815"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2887,
+ "module": "_resource_clients.build_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n",
+ "args": {
+ "limit": "How many builds to retrieve.",
+ "offset": "What build to include as first when retrieving the list.",
+ "desc": "Whether to sort the builds in descending order based on their start date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 64
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2888,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many builds to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2889,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What build to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2890,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the builds in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2891,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2892,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildShort",
+ "target": "358"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4103,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2877,
+ 2887,
+ 2881
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4103
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2876,
+ "module": "_resource_clients.build_collection",
+ "name": "BuildCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 18
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2894,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 104
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2898,
+ "module": "_resource_clients.build_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n",
+ "args": {
+ "limit": "How many builds to retrieve.",
+ "offset": "What build to include as first when retrieving the list.",
+ "desc": "Whether to sort the builds in descending order based on their start date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor builds."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor builds."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2899,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many builds to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2900,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What build to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2901,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the builds in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2902,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2903,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfBuilds",
+ "type": "reference",
+ "target": "815"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2904,
+ "module": "_resource_clients.build_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n",
+ "args": {
+ "limit": "How many builds to retrieve.",
+ "offset": "What build to include as first when retrieving the list.",
+ "desc": "Whether to sort the builds in descending order based on their start date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 143
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2905,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many builds to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2906,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What build to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2907,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the builds in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2908,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2909,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "BuildShort",
+ "target": "358"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4076,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2894,
+ 2904,
+ 2898
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4076
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2893,
+ "module": "_resource_clients.build_collection",
+ "name": "BuildCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 97
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of dataset items. Each item is a JSON object (dictionary)."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2911,
+ "module": "_resource_clients.dataset",
+ "name": "items",
+ "parsedDocstring": {
+ "text": "List of dataset items. Each item is a JSON object (dictionary)."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Total number of items in the dataset."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2912,
+ "module": "_resource_clients.dataset",
+ "name": "total",
+ "parsedDocstring": {
+ "text": "Total number of items in the dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 40
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The offset of the first item in this page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2913,
+ "module": "_resource_clients.dataset",
+ "name": "offset",
+ "parsedDocstring": {
+ "text": "The offset of the first item in this page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 43
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items in this page."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2914,
+ "module": "_resource_clients.dataset",
+ "name": "count",
+ "parsedDocstring": {
+ "text": "Number of items in this page."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The limit that was used for this request."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2915,
+ "module": "_resource_clients.dataset",
+ "name": "limit",
+ "parsedDocstring": {
+ "text": "The limit that was used for this request."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 49
+ }
+ ],
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the items are sorted in descending order."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [],
+ "id": 2916,
+ "module": "_resource_clients.dataset",
+ "name": "desc",
+ "parsedDocstring": {
+ "text": "Whether the items are sorted in descending order."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 52
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Other')",
+ "name": "docs_group"
+ },
+ {
+ "name": "dataclass"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2914,
+ 2916,
+ 2911,
+ 2915,
+ 2913,
+ 2912
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2910,
+ "module": "_resource_clients.dataset",
+ "name": "DatasetItemsPage",
+ "parsedDocstring": {
+ "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 29
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2918,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 64
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 2923,
+ "module": "_resource_clients.dataset",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved dataset, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 77
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved dataset, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2924,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2925,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Dataset",
+ "target": "478"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2926,
+ "module": "_resource_clients.dataset",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n",
+ "args": {
+ "name": "The new name for the dataset.",
+ "general_access": "Determines how others can access the dataset.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 93
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated dataset."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2927,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2928,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2929,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2930,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset",
+ "type": "reference",
+ "target": "478"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2931,
+ "module": "_resource_clients.dataset",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 119
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2932,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2933,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2934,
+ "module": "_resource_clients.dataset",
+ "name": "list_items",
+ "parsedDocstring": {
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "flatten": "A list of fields that should be flattened.",
+ "view": "Name of the dataset view to be used.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "A page of the list of dataset items according to the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 129
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A page of the list of dataset items according to the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2935,
+ "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": 2936,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2937,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2938,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2939,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2940,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2941,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2942,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2943,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2944,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2945,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the dataset view to be used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2946,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "view",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2947,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2948,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetItemsPage",
+ "type": "reference",
+ "target": "2910"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2949,
+ "module": "_resource_clients.dataset",
+ "name": "iterate_items",
+ "parsedDocstring": {
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "signature": "Signature used to access the items.",
+ "chunk_size": "Maximum number of items requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 219
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2950,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items that should be skipped at the start. The default value is 0."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2951,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2952,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2953,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2954,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2955,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2956,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2957,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2958,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2959,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2960,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2961,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2962,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 2963,
+ "module": "_resource_clients.dataset",
+ "name": "get_items_as_bytes",
+ "parsedDocstring": {
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.",
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.",
+ "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_header_row": "If True, then header row in the csv format is skipped.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "xml_root": "Overrides default root element name of xml output. By default the root element is items.",
+ "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.",
+ "flatten": "A list of fields that should be flattened.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset items as raw bytes."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 291
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset items as raw bytes."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2964,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_items_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json."
+ }
+ ]
+ },
+ "defaultValue": "'json'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2965,
+ "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": 2966,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2967,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2968,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2969,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2970,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "bom",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2971,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "delimiter",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2972,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2973,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2974,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2975,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then header row in the csv format is skipped."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2976,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_header_row",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2977,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default root element name of xml output. By default the root element is items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2978,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_root",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2979,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_row",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2980,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2981,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2982,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bytes",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "contextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 2983,
+ "module": "_resource_clients.dataset",
+ "name": "stream_items",
+ "parsedDocstring": {
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.",
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.",
+ "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_header_row": "If True, then header row in the csv format is skipped.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "xml_root": "Overrides default root element name of xml output. By default the root element is items.",
+ "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset items as a context-managed streaming `Response`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 390
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset items as a context-managed streaming `Response`."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 2984,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "stream_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json."
+ }
+ ]
+ },
+ "defaultValue": "'json'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2985,
+ "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": 2986,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2987,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2988,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2989,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2990,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "bom",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2991,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "delimiter",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2992,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2993,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2994,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2995,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then header row in the csv format is skipped."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2996,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_header_row",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2997,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default root element name of xml output. By default the root element is items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2998,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_root",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 2999,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_row",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3000,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3001,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "HttpResponse",
+ "target": "1903"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3002,
+ "module": "_resource_clients.dataset",
+ "name": "push_items",
+ "parsedDocstring": {
+ "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n",
+ "args": {
+ "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 490
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3003,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "push_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3004,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "items",
+ "type": {
+ "name": "JsonSerializable",
+ "type": "reference",
+ "target": "15"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3005,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3006,
+ "module": "_resource_clients.dataset",
+ "name": "get_statistics",
+ "parsedDocstring": {
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset statistics."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 518
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset statistics."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3007,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_statistics",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3008,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetStatistics",
+ "type": "reference",
+ "target": "527"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3009,
+ "module": "_resource_clients.dataset",
+ "name": "create_items_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "clean": "If True, returns only non-empty items and skips hidden fields.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "fields": "A list of fields which should be picked from the items.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed.",
+ "skip_empty": "If True, then empty items are skipped from the output.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output.",
+ "flatten": "A list of fields that should be flattened.",
+ "view": "Name of the dataset view to be used.",
+ "expires_in": "How long the signed URL should be valid.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The public dataset items URL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 541
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The public dataset items URL."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3010,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create_items_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items that should be skipped at the start. The default value is 0."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3011,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3012,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3013,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3014,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3015,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3016,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3017,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3018,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3019,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3020,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the dataset view to be used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3021,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "view",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the signed URL should be valid."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3022,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "expires_in",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3023,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4104,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 2918,
+ 3009,
+ 2931,
+ 2923,
+ 2963,
+ 3006,
+ 2949,
+ 2934,
+ 3002,
+ 2983,
+ 2926
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4104
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 2917,
+ "module": "_resource_clients.dataset",
+ "name": "DatasetClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 57
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3025,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 628
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3030,
+ "module": "_resource_clients.dataset",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved dataset, or None, if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 641
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved dataset, or None, if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3031,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3032,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Dataset",
+ "target": "478"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3033,
+ "module": "_resource_clients.dataset",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n",
+ "args": {
+ "name": "The new name for the dataset.",
+ "general_access": "Determines how others can access the dataset.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 657
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated dataset."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3034,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3035,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3036,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3037,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset",
+ "type": "reference",
+ "target": "478"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3038,
+ "module": "_resource_clients.dataset",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 683
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3039,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3040,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3041,
+ "module": "_resource_clients.dataset",
+ "name": "list_items",
+ "parsedDocstring": {
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "flatten": "A list of fields that should be flattened.",
+ "view": "Name of the dataset view to be used.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "A page of the list of dataset items according to the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 693
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A page of the list of dataset items according to the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3042,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items that should be skipped at the start. The default value is 0."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3043,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3044,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3045,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3046,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3047,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3048,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3049,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3050,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3051,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3052,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the dataset view to be used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3053,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "view",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3054,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3055,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetItemsPage",
+ "type": "reference",
+ "target": "2910"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3056,
+ "module": "_resource_clients.dataset",
+ "name": "iterate_items",
+ "parsedDocstring": {
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "signature": "Signature used to access the items.",
+ "chunk_size": "Maximum number of items requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 783
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3057,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items that should be skipped at the start. The default value is 0."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3058,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3059,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3060,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3061,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3062,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3063,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3064,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3065,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3066,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3067,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3068,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3069,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3070,
+ "module": "_resource_clients.dataset",
+ "name": "get_items_as_bytes",
+ "parsedDocstring": {
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.",
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.",
+ "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_header_row": "If True, then header row in the csv format is skipped.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "xml_root": "Overrides default root element name of xml output. By default the root element is items.",
+ "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.",
+ "flatten": "A list of fields that should be flattened.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset items as raw bytes."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 857
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset items as raw bytes."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3071,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_items_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json."
+ }
+ ]
+ },
+ "defaultValue": "'json'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3072,
+ "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": 3073,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3074,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3075,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3076,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3077,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "bom",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3078,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "delimiter",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3079,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3080,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3081,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3082,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then header row in the csv format is skipped."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3083,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_header_row",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3084,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default root element name of xml output. By default the root element is items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3085,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_root",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3086,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_row",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3087,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3088,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3089,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bytes",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "asynccontextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 3090,
+ "module": "_resource_clients.dataset",
+ "name": "stream_items",
+ "parsedDocstring": {
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n",
+ "args": {
+ "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.",
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.",
+ "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.",
+ "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).",
+ "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.",
+ "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.",
+ "skip_header_row": "If True, then header row in the csv format is skipped.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.",
+ "xml_root": "Overrides default root element name of xml output. By default the root element is items.",
+ "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset items as a context-managed streaming `Response`."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 956
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset items as a context-managed streaming `Response`."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3091,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "stream_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json."
+ }
+ ]
+ },
+ "defaultValue": "'json'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3092,
+ "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": 3093,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3094,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3095,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3096,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3097,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "bom",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3098,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "delimiter",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3099,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3100,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3101,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3102,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then header row in the csv format is skipped."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3103,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_header_row",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3104,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default root element name of xml output. By default the root element is items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3105,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_root",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3106,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "xml_row",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3107,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3108,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "HttpResponse",
+ "target": "1903"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3109,
+ "module": "_resource_clients.dataset",
+ "name": "push_items",
+ "parsedDocstring": {
+ "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n",
+ "args": {
+ "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1056
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3110,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "push_items",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3111,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "items",
+ "type": {
+ "name": "JsonSerializable",
+ "type": "reference",
+ "target": "15"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3112,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3113,
+ "module": "_resource_clients.dataset",
+ "name": "get_statistics",
+ "parsedDocstring": {
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The dataset statistics."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1084
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The dataset statistics."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3114,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_statistics",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3115,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "DatasetStatistics",
+ "type": "reference",
+ "target": "527"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3116,
+ "module": "_resource_clients.dataset",
+ "name": "create_items_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n",
+ "args": {
+ "offset": "Number of items that should be skipped at the start. The default value is 0.",
+ "limit": "Maximum number of items to return. By default there is no limit.",
+ "clean": "If True, returns only non-empty items and skips hidden fields.",
+ "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.",
+ "fields": "A list of fields which should be picked from the items.",
+ "omit": "A list of fields which should be omitted from the items.",
+ "unwind": "A list of fields which should be unwound, in order which they should be processed.",
+ "skip_empty": "If True, then empty items are skipped from the output.",
+ "skip_hidden": "If True, then hidden fields are skipped from the output.",
+ "flatten": "A list of fields that should be flattened.",
+ "view": "Name of the dataset view to be used.",
+ "expires_in": "How long the signed URL should be valid.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The public dataset items URL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1107
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The public dataset items URL."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3117,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create_items_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of items that should be skipped at the start. The default value is 0."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3118,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3119,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, returns only non-empty items and skips hidden fields."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3120,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "clean",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3121,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be picked from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3122,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "fields",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be omitted from the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3123,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "omit",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields which should be unwound, in order which they should be processed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3124,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unwind",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then empty items are skipped from the output."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3125,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_empty",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then hidden fields are skipped from the output."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3126,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "skip_hidden",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of fields that should be flattened."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3127,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "flatten",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Name of the dataset view to be used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3128,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "view",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the signed URL should be valid."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3129,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "expires_in",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3130,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4077,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3025,
+ 3116,
+ 3038,
+ 3030,
+ 3070,
+ 3113,
+ 3056,
+ 3041,
+ 3109,
+ 3090,
+ 3033
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4077
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3024,
+ "module": "_resource_clients.dataset",
+ "name": "DatasetClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 621
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3132,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 44
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3137,
+ "module": "_resource_clients.run",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 57
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3138,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3139,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3140,
+ "module": "_resource_clients.run",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n",
+ "args": {
+ "status_message": "The new status message for the run.",
+ "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.",
+ "general_access": "Determines how others can access the run and its storages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 73
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3141,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new status message for the run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3142,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status_message",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set this flag to True if this is the final status message of the Actor run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3143,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_status_message_terminal",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the run and its storages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3144,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3145,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3146,
+ "module": "_resource_clients.run",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 102
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3147,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3148,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3149,
+ "module": "_resource_clients.run",
+ "name": "abort",
+ "parsedDocstring": {
+ "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n",
+ "args": {
+ "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The data of the aborted Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 112
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The data of the aborted Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3150,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "abort",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3151,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "gracefully",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3152,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3153,
+ "module": "_resource_clients.run",
+ "name": "wait_for_finish",
+ "parsedDocstring": {
+ "text": "Wait synchronously until the run finishes or the server times out.\n",
+ "args": {
+ "wait_duration": "How long does the client wait for run to finish. None for indefinite.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 135
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait synchronously until the run finishes or the server times out.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3154,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "wait_for_finish",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long does the client wait for run to finish. None for indefinite."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3155,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3156,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3157,
+ "module": "_resource_clients.run",
+ "name": "metamorph",
+ "parsedDocstring": {
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n",
+ "args": {
+ "target_actor_id": "ID of the target Actor that the run should be transformed into.",
+ "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).",
+ "run_input": "The input to pass to the new run.",
+ "content_type": "The content type of the input.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 163
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3158,
+ "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": 3159,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "target_actor_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3160,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "target_actor_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to pass to the new run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3161,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3162,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3163,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3164,
+ "module": "_resource_clients.run",
+ "name": "resurrect",
+ "parsedDocstring": {
+ "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n",
+ "args": {
+ "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.",
+ "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.",
+ "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.",
+ "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.",
+ "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.",
+ "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 206
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3165,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "resurrect",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3166,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3167,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3168,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3169,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3170,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3171,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3172,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3173,
+ "module": "_resource_clients.run",
+ "name": "reboot",
+ "parsedDocstring": {
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 261
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3174,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "reboot",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3175,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3176,
+ "module": "_resource_clients.run",
+ "name": "dataset",
+ "parsedDocstring": {
+ "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default dataset of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 280
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default dataset of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3177,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "dataset",
+ "parameters": [],
+ "type": {
+ "name": "DatasetClient",
+ "type": "reference",
+ "target": "2917"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3178,
+ "module": "_resource_clients.run",
+ "name": "key_value_store",
+ "parsedDocstring": {
+ "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default key-value store of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 293
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default key-value store of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3179,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "key_value_store",
+ "parameters": [],
+ "type": {
+ "name": "KeyValueStoreClient",
+ "type": "reference",
+ "target": "3706"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3180,
+ "module": "_resource_clients.run",
+ "name": "request_queue",
+ "parsedDocstring": {
+ "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default request_queue of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 306
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default request_queue of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3181,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "request_queue",
+ "parameters": [],
+ "type": {
+ "name": "RequestQueueClient",
+ "type": "reference",
+ "target": "2094"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3182,
+ "module": "_resource_clients.run",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the log of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 319
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the log of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3183,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "log",
+ "parameters": [],
+ "type": {
+ "name": "LogClient",
+ "type": "reference",
+ "target": "2258"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3184,
+ "module": "_resource_clients.run",
+ "name": "get_streamed_log",
+ "parsedDocstring": {
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n",
+ "args": {
+ "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created",
+ "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "`StreamedLog` instance for redirected logs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 332
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "`StreamedLog` instance for redirected logs."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3185,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_streamed_log",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 3186,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "logging.Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by."
+ }
+ ]
+ },
+ "defaultValue": "True",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3187,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "from_start",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3188,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "StreamedLog",
+ "type": "reference",
+ "target": "44"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3189,
+ "module": "_resource_clients.run",
+ "name": "charge",
+ "parsedDocstring": {
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n",
+ "args": {
+ "event_name": "The name of the event to charge for.",
+ "count": "The number of events to charge.",
+ "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 375
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3190,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "charge",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the event to charge for."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3191,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of events to charge."
+ }
+ ]
+ },
+ "defaultValue": "1",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3192,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "count",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3193,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "idempotency_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3194,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3195,
+ "module": "_resource_clients.run",
+ "name": "get_status_message_watcher",
+ "parsedDocstring": {
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n",
+ "args": {
+ "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.",
+ "check_period": "The period with which the status message will be polled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "`StatusMessageWatcher` instance."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 421
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "`StatusMessageWatcher` instance."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3196,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_status_message_watcher",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3197,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "logging.Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The period with which the status message will be polled."
+ }
+ ]
+ },
+ "defaultValue": "timedelta(seconds=1)",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3198,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "check_period",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3199,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "StatusMessageWatcher",
+ "type": "reference",
+ "target": "1791"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4105,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3132,
+ 3149,
+ 3189,
+ 3176,
+ 3146,
+ 3137,
+ 3195,
+ 3184,
+ 3178,
+ 3182,
+ 3157,
+ 3173,
+ 3180,
+ 3164,
+ 3140,
+ 3153
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4105
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3131,
+ "module": "_resource_clients.run",
+ "name": "RunClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 37
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3201,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 472
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3206,
+ "module": "_resource_clients.run",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 485
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3207,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3208,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3209,
+ "module": "_resource_clients.run",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n",
+ "args": {
+ "status_message": "The new status message for the run.",
+ "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.",
+ "general_access": "Determines how others can access the run and its storages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 501
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3210,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new status message for the run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3211,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status_message",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set this flag to True if this is the final status message of the Actor run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3212,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_status_message_terminal",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the run and its storages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3213,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3214,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3215,
+ "module": "_resource_clients.run",
+ "name": "abort",
+ "parsedDocstring": {
+ "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n",
+ "args": {
+ "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The data of the aborted Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 530
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The data of the aborted Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3216,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "abort",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3217,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "gracefully",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3218,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait asynchronously until the run finishes or the server times out.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3219,
+ "module": "_resource_clients.run",
+ "name": "wait_for_finish",
+ "parsedDocstring": {
+ "text": "Wait asynchronously until the run finishes or the server times out.\n",
+ "args": {
+ "wait_duration": "How long does the client wait for run to finish. None for indefinite.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 553
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait asynchronously until the run finishes or the server times out.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3220,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "wait_for_finish",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long does the client wait for run to finish. None for indefinite."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3221,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3222,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3223,
+ "module": "_resource_clients.run",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 577
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3224,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3225,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3226,
+ "module": "_resource_clients.run",
+ "name": "metamorph",
+ "parsedDocstring": {
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n",
+ "args": {
+ "target_actor_id": "ID of the target Actor that the run should be transformed into.",
+ "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).",
+ "run_input": "The input to pass to the new run.",
+ "content_type": "The content type of the input.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 587
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3227,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "metamorph",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ID of the target Actor that the run should be transformed into."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3228,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "target_actor_id",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3229,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "target_actor_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to pass to the new run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3230,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3231,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3232,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3233,
+ "module": "_resource_clients.run",
+ "name": "resurrect",
+ "parsedDocstring": {
+ "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n",
+ "args": {
+ "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.",
+ "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.",
+ "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.",
+ "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.",
+ "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.",
+ "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 633
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3234,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "resurrect",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3235,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3236,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3237,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3238,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3239,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3240,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3241,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3242,
+ "module": "_resource_clients.run",
+ "name": "reboot",
+ "parsedDocstring": {
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor run data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 688
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor run data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3243,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "reboot",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3244,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3245,
+ "module": "_resource_clients.run",
+ "name": "dataset",
+ "parsedDocstring": {
+ "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default dataset of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 707
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default dataset of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3246,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "dataset",
+ "parameters": [],
+ "type": {
+ "name": "DatasetClientAsync",
+ "type": "reference",
+ "target": "3024"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3247,
+ "module": "_resource_clients.run",
+ "name": "key_value_store",
+ "parsedDocstring": {
+ "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default key-value store of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 720
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default key-value store of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3248,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "key_value_store",
+ "parameters": [],
+ "type": {
+ "name": "KeyValueStoreClientAsync",
+ "type": "reference",
+ "target": "3781"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3249,
+ "module": "_resource_clients.run",
+ "name": "request_queue",
+ "parsedDocstring": {
+ "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the default request_queue of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 733
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the default request_queue of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3250,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "request_queue",
+ "parameters": [],
+ "type": {
+ "name": "RequestQueueClientAsync",
+ "type": "reference",
+ "target": "2176"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3251,
+ "module": "_resource_clients.run",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n",
+ "returns": "A client allowing access to the log of this Actor run."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 746
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the log of this Actor run."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3252,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "log",
+ "parameters": [],
+ "type": {
+ "name": "LogClientAsync",
+ "type": "reference",
+ "target": "2275"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3253,
+ "module": "_resource_clients.run",
+ "name": "get_streamed_log",
+ "parsedDocstring": {
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n",
+ "args": {
+ "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created",
+ "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "`StreamedLog` instance for redirected logs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 759
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "`StreamedLog` instance for redirected logs."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3254,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_streamed_log",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 3255,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "logging.Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by."
+ }
+ ]
+ },
+ "defaultValue": "True",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3256,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "from_start",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3257,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "StreamedLogAsync",
+ "type": "reference",
+ "target": "61"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3258,
+ "module": "_resource_clients.run",
+ "name": "charge",
+ "parsedDocstring": {
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n",
+ "args": {
+ "event_name": "The name of the event to charge for.",
+ "count": "The number of events to charge.",
+ "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 802
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3259,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "charge",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the event to charge for."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3260,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The number of events to charge."
+ }
+ ]
+ },
+ "defaultValue": "1",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3261,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "count",
+ "type": {
+ "name": "int",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3262,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "idempotency_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3263,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3264,
+ "module": "_resource_clients.run",
+ "name": "get_status_message_watcher",
+ "parsedDocstring": {
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n",
+ "args": {
+ "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.",
+ "check_period": "The period with which the status message will be polled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "`StatusMessageWatcher` instance."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 848
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "`StatusMessageWatcher` instance."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3265,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_status_message_watcher",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3266,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "to_logger",
+ "type": {
+ "name": "logging.Logger | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "logging.Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The period with which the status message will be polled."
+ }
+ ]
+ },
+ "defaultValue": "timedelta(seconds=1)",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3267,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "check_period",
+ "type": {
+ "name": "timedelta",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3268,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "StatusMessageWatcherAsync",
+ "type": "reference",
+ "target": "1774"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4078,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3201,
+ 3215,
+ 3258,
+ 3245,
+ 3223,
+ 3206,
+ 3264,
+ 3253,
+ 3247,
+ 3251,
+ 3226,
+ 3242,
+ 3249,
+ 3233,
+ 3209,
+ 3219
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4078
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3200,
+ "module": "_resource_clients.run",
+ "name": "RunClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 465
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3270,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3275,
+ "module": "_resource_clients.build",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor build data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor build data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3276,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3277,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Build",
+ "target": "330"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3278,
+ "module": "_resource_clients.build",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 54
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3279,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3280,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3281,
+ "module": "_resource_clients.build",
+ "name": "abort",
+ "parsedDocstring": {
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The data of the aborted Actor build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 64
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The data of the aborted Actor build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3282,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "abort",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3283,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build",
+ "type": "reference",
+ "target": "330"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3284,
+ "module": "_resource_clients.build",
+ "name": "get_open_api_definition",
+ "parsedDocstring": {
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "OpenAPI definition of the Actor's build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 84
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "OpenAPI definition of the Actor's build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3285,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_open_api_definition",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3286,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait synchronously until the build finishes or the server times out.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3287,
+ "module": "_resource_clients.build",
+ "name": "wait_for_finish",
+ "parsedDocstring": {
+ "text": "Wait synchronously until the build finishes or the server times out.\n",
+ "args": {
+ "wait_duration": "How long does the client wait for build to finish. None for indefinite.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 102
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait synchronously until the build finishes or the server times out.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3288,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "wait_for_finish",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long does the client wait for build to finish. None for indefinite."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3289,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3290,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Build",
+ "target": "330"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3291,
+ "module": "_resource_clients.build",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n",
+ "returns": "A client allowing access to the log of this Actor build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 123
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the log of this Actor build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3292,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "log",
+ "parameters": [],
+ "type": {
+ "name": "LogClient",
+ "type": "reference",
+ "target": "2258"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4106,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3270,
+ 3281,
+ 3278,
+ 3275,
+ 3284,
+ 3291,
+ 3287
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4106
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3269,
+ "module": "_resource_clients.build",
+ "name": "BuildClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 18
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3294,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 145
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3299,
+ "module": "_resource_clients.build",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor build data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 158
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor build data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3300,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3301,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Build",
+ "target": "330"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3302,
+ "module": "_resource_clients.build",
+ "name": "abort",
+ "parsedDocstring": {
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The data of the aborted Actor build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 174
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The data of the aborted Actor build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3303,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "abort",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3304,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build",
+ "type": "reference",
+ "target": "330"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3305,
+ "module": "_resource_clients.build",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 194
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3306,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3307,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3308,
+ "module": "_resource_clients.build",
+ "name": "get_open_api_definition",
+ "parsedDocstring": {
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "OpenAPI definition of the Actor's build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 204
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "OpenAPI definition of the Actor's build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3309,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_open_api_definition",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3310,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait asynchronously until the build finishes or the server times out.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3311,
+ "module": "_resource_clients.build",
+ "name": "wait_for_finish",
+ "parsedDocstring": {
+ "text": "Wait asynchronously until the build finishes or the server times out.\n",
+ "args": {
+ "wait_duration": "How long does the client wait for build to finish. None for indefinite.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 222
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Wait asynchronously until the build finishes or the server times out.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3312,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "wait_for_finish",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long does the client wait for build to finish. None for indefinite."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3313,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3314,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Build",
+ "target": "330"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3315,
+ "module": "_resource_clients.build",
+ "name": "log",
+ "parsedDocstring": {
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n",
+ "returns": "A client allowing access to the log of this Actor build."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 243
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to the log of this Actor build."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3316,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "log",
+ "parameters": [],
+ "type": {
+ "name": "LogClientAsync",
+ "type": "reference",
+ "target": "2275"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4079,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3294,
+ 3302,
+ 3305,
+ 3299,
+ 3308,
+ 3315,
+ 3311
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4079
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3293,
+ "module": "_resource_clients.build",
+ "name": "BuildClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/build.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 138
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3318,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3322,
+ "module": "_resource_clients.schedule_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n",
+ "args": {
+ "limit": "How many schedules to retrieve.",
+ "offset": "What schedules to include as first when retrieving the list.",
+ "desc": "Whether to sort the schedules in descending order based on their modification date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available schedules matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available schedules matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3323,
+ "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": 3324,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What schedules to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3325,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the schedules in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3326,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3327,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfSchedules",
+ "type": "reference",
+ "target": "833"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3328,
+ "module": "_resource_clients.schedule_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n",
+ "args": {
+ "limit": "How many schedules to retrieve.",
+ "offset": "What schedules to include as first when retrieving the list.",
+ "desc": "Whether to sort the schedules in descending order based on their modification date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 66
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3329,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many schedules to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3330,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What schedules to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3331,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the schedules in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3332,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3333,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleShort",
+ "target": "1235"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3334,
+ "module": "_resource_clients.schedule_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n",
+ "args": {
+ "cron_expression": "The cron expression used by this schedule.",
+ "is_enabled": "True if the schedule should be enabled.",
+ "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.",
+ "name": "The name of the schedule to create.",
+ "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.",
+ "description": "Description of this schedule.",
+ "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
+ "title": "Title of this schedule.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 96
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3335,
+ "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": 3336,
+ "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": 3337,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_enabled",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3338,
+ "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": 3339,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3340,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Description of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3341,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3342,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timezone",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Title of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3343,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3344,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule",
+ "type": "reference",
+ "target": "1197"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4107,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3318,
+ 3334,
+ 3328,
+ 3322
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4107
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3317,
+ "module": "_resource_clients.schedule_collection",
+ "name": "ScheduleCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 24
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3346,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 154
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3350,
+ "module": "_resource_clients.schedule_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n",
+ "args": {
+ "limit": "How many schedules to retrieve.",
+ "offset": "What schedules to include as first when retrieving the list.",
+ "desc": "Whether to sort the schedules in descending order based on their modification date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available schedules matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 165
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available schedules matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3351,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many schedules to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3352,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What schedules to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3353,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the schedules in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3354,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3355,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfSchedules",
+ "type": "reference",
+ "target": "833"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3356,
+ "module": "_resource_clients.schedule_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n",
+ "args": {
+ "limit": "How many schedules to retrieve.",
+ "offset": "What schedules to include as first when retrieving the list.",
+ "desc": "Whether to sort the schedules in descending order based on their modification date.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 189
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3357,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many schedules to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3358,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What schedules to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3359,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the schedules in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3360,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3361,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ScheduleShort",
+ "target": "1235"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3362,
+ "module": "_resource_clients.schedule_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n",
+ "args": {
+ "cron_expression": "The cron expression used by this schedule.",
+ "is_enabled": "True if the schedule should be enabled.",
+ "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.",
+ "name": "The name of the schedule to create.",
+ "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.",
+ "description": "Description of this schedule.",
+ "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
+ "title": "Title of this schedule.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created schedule."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 219
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created schedule."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3363,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The cron expression used by this schedule."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3364,
+ "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": 3365,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_enabled",
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3366,
+ "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": 3367,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3368,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Description of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3369,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3370,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timezone",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Title of this schedule."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3371,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3372,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Schedule",
+ "type": "reference",
+ "target": "1197"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4080,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3346,
+ 3362,
+ 3356,
+ 3350
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4080
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3345,
+ "module": "_resource_clients.schedule_collection",
+ "name": "ScheduleCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/schedule_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 147
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3374,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3378,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actor versions."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 49
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actor versions."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3379,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3380,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfVersions",
+ "type": "reference",
+ "target": "756"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3381,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 63
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3382,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3383,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3384,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n",
+ "args": {
+ "version_number": "Major and minor version of the Actor (e.g. `1.0`).",
+ "build_tag": "Tag that is automatically set to the latest successful build of the current version.",
+ "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.",
+ "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.",
+ "source_type": "What source type is the Actor version using.",
+ "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.",
+ "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.",
+ "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.",
+ "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 81
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3385,
+ "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": 3386,
+ "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": 3387,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3388,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_vars",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3389,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "apply_env_vars_to_build",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What source type is the Actor version using."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3390,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_type",
+ "type": {
+ "name": "VersionSourceType",
+ "type": "reference",
+ "target": "1900"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3391,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_files",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3392,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "git_repo_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3393,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tarball_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3394,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "github_gist_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3395,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version",
+ "type": "reference",
+ "target": "1424"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4108,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3374,
+ 3384,
+ 3381,
+ 3378
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4108
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3373,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "ActorVersionCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3397,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 143
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3401,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available Actor versions."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 154
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available Actor versions."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3402,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3403,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfVersions",
+ "type": "reference",
+ "target": "756"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3404,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 168
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3405,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3406,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "Version",
+ "target": "1424"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3407,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n",
+ "args": {
+ "version_number": "Major and minor version of the Actor (e.g. `1.0`).",
+ "build_tag": "Tag that is automatically set to the latest successful build of the current version.",
+ "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.",
+ "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.",
+ "source_type": "What source type is the Actor version using.",
+ "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.",
+ "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.",
+ "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.",
+ "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 187
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3408,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Major and minor version of the Actor (e.g. `1.0`)."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3409,
+ "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": 3410,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3411,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "env_vars",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3412,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "apply_env_vars_to_build",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What source type is the Actor version using."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3413,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_type",
+ "type": {
+ "name": "VersionSourceType",
+ "type": "reference",
+ "target": "1900"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3414,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "source_files",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3415,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "git_repo_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3416,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tarball_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3417,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "github_gist_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3418,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Version",
+ "type": "reference",
+ "target": "1424"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4081,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3397,
+ 3407,
+ 3404,
+ 3401
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4081
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3396,
+ "module": "_resource_clients.actor_version_collection",
+ "name": "ActorVersionCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 136
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3420,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 31
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3424,
+ "module": "_resource_clients.dataset_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n",
+ "args": {
+ "unnamed": "Whether to include unnamed datasets in the list.",
+ "limit": "How many datasets to retrieve.",
+ "offset": "What dataset to include as first when retrieving the list.",
+ "desc": "Whether to sort the datasets in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available datasets matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 42
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available datasets matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3425,
+ "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": 3426,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many datasets to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3427,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What dataset to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3428,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the datasets in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3429,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3430,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3431,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfDatasets",
+ "type": "reference",
+ "target": "818"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3432,
+ "module": "_resource_clients.dataset_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n",
+ "args": {
+ "unnamed": "Whether to include unnamed datasets in the list.",
+ "limit": "How many datasets to retrieve.",
+ "offset": "What dataset to include as first when retrieving the list.",
+ "desc": "Whether to sort the datasets in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 78
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3433,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed datasets in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3434,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many datasets to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3435,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What dataset to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3436,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the datasets in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3437,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3438,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3439,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetListItem",
+ "target": "503"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3440,
+ "module": "_resource_clients.dataset_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n",
+ "args": {
+ "name": "The name of the dataset to retrieve or create.",
+ "schema": "The schema of the dataset.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created dataset."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3441,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the dataset to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3442,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The schema of the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3443,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schema",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3444,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset",
+ "type": "reference",
+ "target": "478"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4109,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3420,
+ 3440,
+ 3432,
+ 3424
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4109
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3419,
+ "module": "_resource_clients.dataset_collection",
+ "name": "DatasetCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 24
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3446,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 146
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3450,
+ "module": "_resource_clients.dataset_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n",
+ "args": {
+ "unnamed": "Whether to include unnamed datasets in the list.",
+ "limit": "How many datasets to retrieve.",
+ "offset": "What dataset to include as first when retrieving the list.",
+ "desc": "Whether to sort the datasets in descending order based on their modification date.",
+ "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available datasets matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 157
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available datasets matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3451,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed datasets in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3452,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many datasets to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3453,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What dataset to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3454,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the datasets in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3455,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3456,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3457,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfDatasets",
+ "type": "reference",
+ "target": "818"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3458,
+ "module": "_resource_clients.dataset_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n",
+ "args": {
+ "unnamed": "Whether to include unnamed datasets in the list.",
+ "limit": "How many datasets to retrieve.",
+ "offset": "What dataset to include as first when retrieving the list.",
+ "desc": "Whether to sort the datasets in descending order based on their modification date.",
+ "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 193
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3459,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to include unnamed datasets in the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3460,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "unnamed",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many datasets to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3461,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What dataset to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3462,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the datasets in descending order based on their modification date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3463,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3464,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ownership",
+ "type": {
+ "name": "StorageOwnership | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "StorageOwnership",
+ "target": "1899"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3465,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "DatasetListItem",
+ "target": "503"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3466,
+ "module": "_resource_clients.dataset_collection",
+ "name": "get_or_create",
+ "parsedDocstring": {
+ "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n",
+ "args": {
+ "name": "The name of the dataset to retrieve or create.",
+ "schema": "The schema of the dataset.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved or newly-created dataset."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 230
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved or newly-created dataset."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3467,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_or_create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the dataset to retrieve or create."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3468,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The schema of the dataset."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3469,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "schema",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3470,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Dataset",
+ "type": "reference",
+ "target": "478"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4082,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3446,
+ 3466,
+ 3458,
+ 3450
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4082
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3445,
+ "module": "_resource_clients.dataset_collection",
+ "name": "DatasetCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/dataset_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 139
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3472,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3473,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3474,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3475,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3476,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3477,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3478,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3479,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3480,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 3481,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities."
+ }
+ ]
+ },
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3472
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 3481
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3471,
+ "module": "_resource_clients._resource_client",
+ "name": "ResourceClientBase",
+ "parsedDocstring": {
+ "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedBy": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ },
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3483,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 174
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientBase.__init__",
+ "target": 3472,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4060,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class for synchronous resource clients."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3483
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4060
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3482,
+ "module": "_resource_clients._resource_client",
+ "name": "ResourceClient",
+ "parsedDocstring": {
+ "text": "Base class for synchronous resource clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 171
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientBase",
+ "target": "3471",
+ "type": "reference"
+ }
+ ],
+ "extendedBy": [
+ {
+ "name": "ScheduleClient",
+ "target": "2002",
+ "type": "reference"
+ },
+ {
+ "name": "UserClient",
+ "target": "2054",
+ "type": "reference"
+ },
+ {
+ "name": "RequestQueueClient",
+ "target": "2094",
+ "type": "reference"
+ },
+ {
+ "name": "LogClient",
+ "target": "2258",
+ "type": "reference"
+ },
+ {
+ "name": "ActorEnvVarCollectionClient",
+ "target": "2292",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookDispatchCollectionClient",
+ "target": "2326",
+ "type": "reference"
+ },
+ {
+ "name": "ActorCollectionClient",
+ "target": "2360",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookDispatchClient",
+ "target": "2452",
+ "type": "reference"
+ },
+ {
+ "name": "KeyValueStoreCollectionClient",
+ "target": "2470",
+ "type": "reference"
+ },
+ {
+ "name": "ActorVersionClient",
+ "target": "2522",
+ "type": "reference"
+ },
+ {
+ "name": "RequestQueueCollectionClient",
+ "target": "2578",
+ "type": "reference"
+ },
+ {
+ "name": "TaskCollectionClient",
+ "target": "2628",
+ "type": "reference"
+ },
+ {
+ "name": "StoreCollectionClient",
+ "target": "2696",
+ "type": "reference"
+ },
+ {
+ "name": "TaskClient",
+ "target": "2746",
+ "type": "reference"
+ },
+ {
+ "name": "BuildCollectionClient",
+ "target": "2876",
+ "type": "reference"
+ },
+ {
+ "name": "DatasetClient",
+ "target": "2917",
+ "type": "reference"
+ },
+ {
+ "name": "RunClient",
+ "target": "3131",
+ "type": "reference"
+ },
+ {
+ "name": "BuildClient",
+ "target": "3269",
+ "type": "reference"
+ },
+ {
+ "name": "ScheduleCollectionClient",
+ "target": "3317",
+ "type": "reference"
+ },
+ {
+ "name": "ActorVersionCollectionClient",
+ "target": "3373",
+ "type": "reference"
+ },
+ {
+ "name": "DatasetCollectionClient",
+ "target": "3419",
+ "type": "reference"
+ },
+ {
+ "name": "ActorClient",
+ "target": "3502",
+ "type": "reference"
+ },
+ {
+ "name": "KeyValueStoreClient",
+ "target": "3706",
+ "type": "reference"
+ },
+ {
+ "name": "ActorEnvVarClient",
+ "target": "3856",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookCollectionClient",
+ "target": "3892",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookClient",
+ "target": "3954",
+ "type": "reference"
+ },
+ {
+ "name": "RunCollectionClient",
+ "target": "4014",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3493,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 366
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientBase.__init__",
+ "target": 3472,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4061,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Base class for asynchronous resource clients."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3493
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4061
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3492,
+ "module": "_resource_clients._resource_client",
+ "name": "ResourceClientAsync",
+ "parsedDocstring": {
+ "text": "Base class for asynchronous resource clients."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 363
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientBase",
+ "target": "3471",
+ "type": "reference"
+ }
+ ],
+ "extendedBy": [
+ {
+ "name": "ScheduleClientAsync",
+ "target": "2028",
+ "type": "reference"
+ },
+ {
+ "name": "UserClientAsync",
+ "target": "2074",
+ "type": "reference"
+ },
+ {
+ "name": "RequestQueueClientAsync",
+ "target": "2176",
+ "type": "reference"
+ },
+ {
+ "name": "LogClientAsync",
+ "target": "2275",
+ "type": "reference"
+ },
+ {
+ "name": "ActorEnvVarCollectionClientAsync",
+ "target": "2309",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookDispatchCollectionClientAsync",
+ "target": "2343",
+ "type": "reference"
+ },
+ {
+ "name": "ActorCollectionClientAsync",
+ "target": "2406",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookDispatchClientAsync",
+ "target": "2461",
+ "type": "reference"
+ },
+ {
+ "name": "KeyValueStoreCollectionClientAsync",
+ "target": "2496",
+ "type": "reference"
+ },
+ {
+ "name": "ActorVersionClientAsync",
+ "target": "2550",
+ "type": "reference"
+ },
+ {
+ "name": "RequestQueueCollectionClientAsync",
+ "target": "2603",
+ "type": "reference"
+ },
+ {
+ "name": "TaskCollectionClientAsync",
+ "target": "2662",
+ "type": "reference"
+ },
+ {
+ "name": "StoreCollectionClientAsync",
+ "target": "2721",
+ "type": "reference"
+ },
+ {
+ "name": "TaskClientAsync",
+ "target": "2811",
+ "type": "reference"
+ },
+ {
+ "name": "BuildCollectionClientAsync",
+ "target": "2893",
+ "type": "reference"
+ },
+ {
+ "name": "DatasetClientAsync",
+ "target": "3024",
+ "type": "reference"
+ },
+ {
+ "name": "RunClientAsync",
+ "target": "3200",
+ "type": "reference"
+ },
+ {
+ "name": "BuildClientAsync",
+ "target": "3293",
+ "type": "reference"
+ },
+ {
+ "name": "ScheduleCollectionClientAsync",
+ "target": "3345",
+ "type": "reference"
+ },
+ {
+ "name": "ActorVersionCollectionClientAsync",
+ "target": "3396",
+ "type": "reference"
+ },
+ {
+ "name": "DatasetCollectionClientAsync",
+ "target": "3445",
+ "type": "reference"
+ },
+ {
+ "name": "ActorClientAsync",
+ "target": "3604",
+ "type": "reference"
+ },
+ {
+ "name": "KeyValueStoreClientAsync",
+ "target": "3781",
+ "type": "reference"
+ },
+ {
+ "name": "ActorEnvVarClientAsync",
+ "target": "3874",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookCollectionClientAsync",
+ "target": "3923",
+ "type": "reference"
+ },
+ {
+ "name": "WebhookClientAsync",
+ "target": "3984",
+ "type": "reference"
+ },
+ {
+ "name": "RunCollectionClientAsync",
+ "target": "4037",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3503,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 74
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3508,
+ "module": "_resource_clients.actor",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 87
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3509,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3510,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Actor",
+ "target": "199"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3511,
+ "module": "_resource_clients.actor",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n",
+ "args": {
+ "name": "The name of the Actor.",
+ "title": "The title of the Actor (human-readable).",
+ "description": "The description for the Actor.",
+ "seo_title": "The title of the Actor optimized for search engines.",
+ "seo_description": "The description of the Actor optimized for search engines.",
+ "versions": "The list of Actor versions.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "is_public": "Whether the Actor is public.",
+ "is_deprecated": "Whether the Actor is deprecated.",
+ "categories": "The categories to which the Actor belongs to.",
+ "default_run_build": "Tag or number of the build that you want to run by default.",
+ "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.",
+ "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.",
+ "default_run_timeout": "Default timeout for the runs of this Actor.",
+ "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.",
+ "example_run_input_content_type": "The content type of the example run input.",
+ "actor_standby_is_enabled": "Whether the Actor Standby is enabled.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "pricing_infos": "A list of objects that describes the pricing of the Actor.",
+ "actor_permission_level": "The permission level of the Actor on Apify platform.",
+ "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 103
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3512,
+ "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": 3513,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor (human-readable)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3514,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3515,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3516,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3517,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The list of Actor versions."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3518,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "versions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3519,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is public."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3520,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_public",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is deprecated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3521,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_deprecated",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The categories to which the Actor belongs to."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3522,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "categories",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag or number of the build that you want to run by default."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3523,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3524,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default amount of memory allocated for the runs of this Actor, in megabytes."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3525,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for the runs of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3526,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Input to be prefilled as default input to new users of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3527,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_body",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the example run input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3528,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor Standby is enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3529,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3530,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3531,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3532,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3533,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3534,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of objects that describes the pricing of the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3535,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_infos",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The permission level of the Actor on Apify platform."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3536,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3537,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tagged_builds",
+ "type": {
+ "name": "dict[str, None | dict[str, str]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "literal",
+ "value": null
+ },
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3538,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor",
+ "type": "reference",
+ "target": "199"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3539,
+ "module": "_resource_clients.actor",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 211
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3540,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3541,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3542,
+ "module": "_resource_clients.actor",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n",
+ "args": {
+ "run_input": "The input to pass to the Actor run.",
+ "content_type": "The content type of the input.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.",
+ "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.",
+ "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 221
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3543,
+ "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": 3544,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3545,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3546,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3547,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A limit on the total charged amount for pay-per-event Actors."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3548,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3549,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3550,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3551,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3552,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "force_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3553,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3554,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3555,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3556,
+ "module": "_resource_clients.actor",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n",
+ "args": {
+ "run_input": "The input to pass to the Actor run.",
+ "content_type": "The content type of the input.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.",
+ "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.",
+ "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.",
+ "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.",
+ "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 297
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3557,
+ "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": 3558,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3559,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3560,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3561,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A limit on the total charged amount for pay-per-event Actors."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3562,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3563,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3564,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3565,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3566,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3567,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "force_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3568,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run."
+ }
+ ]
+ },
+ "defaultValue": "'default'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3569,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "logger",
+ "type": {
+ "name": "Logger | None | Literal['default']",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "default"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3570,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3571,
+ "module": "_resource_clients.actor",
+ "name": "build",
+ "parsedDocstring": {
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n",
+ "args": {
+ "version_number": "Actor version number to be built.",
+ "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.",
+ "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.",
+ "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The build object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 380
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The build object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3572,
+ "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": 3573,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "version_number",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3574,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "beta_packages",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3575,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3576,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "use_cache",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3577,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3578,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build",
+ "type": "reference",
+ "target": "330"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the builds of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3579,
+ "module": "_resource_clients.actor",
+ "name": "builds",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the builds of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 428
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the builds of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3580,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "builds",
+ "parameters": [],
+ "type": {
+ "name": "BuildCollectionClient",
+ "type": "reference",
+ "target": "2876"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3581,
+ "module": "_resource_clients.actor",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the runs of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 435
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3582,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClient",
+ "type": "reference",
+ "target": "4014"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3583,
+ "module": "_resource_clients.actor",
+ "name": "default_build",
+ "parsedDocstring": {
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n",
+ "args": {
+ "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The resource client for the default build of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 442
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the default build of this Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3584,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "default_build",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3585,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3586,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BuildClient",
+ "type": "reference",
+ "target": "3269"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3587,
+ "module": "_resource_clients.actor",
+ "name": "last_run",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n",
+ "args": {
+ "status": "Consider only runs with this status.",
+ "origin": "Consider only runs started with this origin.\n"
+ },
+ "returns": "The resource client for the last run of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 480
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the last run of this Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3588,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "last_run",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs with this status."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3589,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs started with this origin.\n"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3590,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "origin",
+ "type": {
+ "name": "RunOrigin | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunOrigin",
+ "target": "1897"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClient",
+ "type": "reference",
+ "target": "3131"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the versions of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3591,
+ "module": "_resource_clients.actor",
+ "name": "versions",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the versions of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 507
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the versions of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3592,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "versions",
+ "parameters": [],
+ "type": {
+ "name": "ActorVersionCollectionClient",
+ "type": "reference",
+ "target": "3373"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3593,
+ "module": "_resource_clients.actor",
+ "name": "version",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the specified version of this Actor.\n",
+ "args": {
+ "version_number": "The version number for which to retrieve the resource client.\n"
+ },
+ "returns": "The resource client for the specified Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 511
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the specified Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified version of this Actor.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3594,
+ "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": 3595,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "version_number",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorVersionClient",
+ "type": "reference",
+ "target": "2522"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3596,
+ "module": "_resource_clients.actor",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 525
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3597,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClient",
+ "type": "reference",
+ "target": "3892"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Validate an input for the Actor that defines an input schema.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3598,
+ "module": "_resource_clients.actor",
+ "name": "validate_input",
+ "parsedDocstring": {
+ "text": "Validate an input for the Actor that defines an input schema.\n",
+ "args": {
+ "run_input": "The input to validate.",
+ "build_tag": "The Actor's build tag.",
+ "content_type": "The content type of the input.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "True if the input is valid, else raise an exception with validation error details."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 529
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "True if the input is valid, else raise an exception with validation error details."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Validate an input for the Actor that defines an input schema.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3599,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "validate_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to validate."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 3600,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Actor's build tag."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3601,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3602,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3603,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4110,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3503,
+ 3571,
+ 3579,
+ 3556,
+ 3583,
+ 3539,
+ 3508,
+ 3587,
+ 3581,
+ 3542,
+ 3511,
+ 3598,
+ 3593,
+ 3591,
+ 3596
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4110
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3502,
+ "module": "_resource_clients.actor",
+ "name": "ActorClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3605,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 570
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3610,
+ "module": "_resource_clients.actor",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 583
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3611,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3612,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Actor",
+ "target": "199"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3613,
+ "module": "_resource_clients.actor",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n",
+ "args": {
+ "name": "The name of the Actor.",
+ "title": "The title of the Actor (human-readable).",
+ "description": "The description for the Actor.",
+ "seo_title": "The title of the Actor optimized for search engines.",
+ "seo_description": "The description of the Actor optimized for search engines.",
+ "versions": "The list of Actor versions.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "is_public": "Whether the Actor is public.",
+ "is_deprecated": "Whether the Actor is deprecated.",
+ "categories": "The categories to which the Actor belongs to.",
+ "default_run_build": "Tag or number of the build that you want to run by default.",
+ "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.",
+ "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.",
+ "default_run_timeout": "Default timeout for the runs of this Actor.",
+ "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.",
+ "example_run_input_content_type": "The content type of the example run input.",
+ "actor_standby_is_enabled": "Whether the Actor Standby is enabled.",
+ "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.",
+ "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.",
+ "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.",
+ "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.",
+ "pricing_infos": "A list of objects that describes the pricing of the Actor.",
+ "actor_permission_level": "The permission level of the Actor on Apify platform.",
+ "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 599
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3614,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3615,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor (human-readable)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3616,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3617,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The title of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3618,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_title",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The description of the Actor optimized for search engines."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3619,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "seo_description",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The list of Actor versions."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3620,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "versions",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3621,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is public."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3622,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_public",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor is deprecated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3623,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_deprecated",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The categories to which the Actor belongs to."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3624,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "categories",
+ "type": {
+ "name": "list[str] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag or number of the build that you want to run by default."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3625,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3626,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default amount of memory allocated for the runs of this Actor, in megabytes."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3627,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Default timeout for the runs of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3628,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "default_run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Input to be prefilled as default input to new users of this Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3629,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_body",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the example run input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3630,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "example_run_input_content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the Actor Standby is enabled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3631,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_is_enabled",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3632,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_desired_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3633,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_max_requests_per_actor_run",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If the Actor run does not receive any requests for this time,\nit will be shut down."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3634,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_idle_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The build tag or number to run when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3635,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The memory in megabytes to use when the Actor is in Standby mode."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3636,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_standby_memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A list of objects that describes the pricing of the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3637,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "pricing_infos",
+ "type": {
+ "name": "list[dict[str, Any]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "Any"
+ }
+ ]
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The permission level of the Actor on Apify platform."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3638,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3639,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tagged_builds",
+ "type": {
+ "name": "dict[str, None | dict[str, str]] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "literal",
+ "value": null
+ },
+ {
+ "type": "reference",
+ "name": "dict",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "str"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3640,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Actor",
+ "type": "reference",
+ "target": "199"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3641,
+ "module": "_resource_clients.actor",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 707
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3642,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3643,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3644,
+ "module": "_resource_clients.actor",
+ "name": "start",
+ "parsedDocstring": {
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n",
+ "args": {
+ "run_input": "The input to pass to the Actor run.",
+ "content_type": "The content type of the input.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.",
+ "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.",
+ "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 717
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3645,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "start",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to pass to the Actor run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3646,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3647,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3648,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3649,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A limit on the total charged amount for pay-per-event Actors."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3650,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3651,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3652,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3653,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3654,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "force_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3655,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3656,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3657,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run",
+ "type": "reference",
+ "target": "1037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3658,
+ "module": "_resource_clients.actor",
+ "name": "call",
+ "parsedDocstring": {
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n",
+ "args": {
+ "run_input": "The input to pass to the Actor run.",
+ "content_type": "The content type of the input.",
+ "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).",
+ "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.",
+ "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.",
+ "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.",
+ "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.",
+ "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.",
+ "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.",
+ "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.",
+ "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.",
+ "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The run object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 793
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The run object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3659,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "call",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to pass to the Actor run."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3660,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3661,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3662,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3663,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_items",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A limit on the total charged amount for pay-per-event Actors."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3664,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "max_total_charge_usd",
+ "type": {
+ "name": "Decimal | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Decimal"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3665,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "restart_on_error",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3666,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "memory_mbytes",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3667,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_timeout",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3668,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "webhooks",
+ "type": {
+ "name": "WebhooksList | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "WebhooksList",
+ "target": "14"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3669,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "force_permission_level",
+ "type": {
+ "name": "ActorPermissionLevel | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorPermissionLevel",
+ "target": "1893"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3670,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_duration",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run."
+ }
+ ]
+ },
+ "defaultValue": "'default'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3671,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "logger",
+ "type": {
+ "name": "Logger | None | Literal['default']",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Logger"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ },
+ {
+ "type": "reference",
+ "name": "Literal",
+ "typeArguments": [
+ {
+ "type": "literal",
+ "value": "default"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'no_timeout'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3672,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Run | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Run",
+ "target": "1037"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3673,
+ "module": "_resource_clients.actor",
+ "name": "build",
+ "parsedDocstring": {
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n",
+ "args": {
+ "version_number": "Actor version number to be built.",
+ "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.",
+ "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.",
+ "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.",
+ "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The build object."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 880
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The build object."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3674,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "build",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Actor version number to be built."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3675,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "version_number",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3676,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "beta_packages",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3677,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3678,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "use_cache",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3679,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3680,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Build",
+ "type": "reference",
+ "target": "330"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the builds of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3681,
+ "module": "_resource_clients.actor",
+ "name": "builds",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the builds of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 928
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the builds of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3682,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "builds",
+ "parameters": [],
+ "type": {
+ "name": "BuildCollectionClientAsync",
+ "type": "reference",
+ "target": "2893"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3683,
+ "module": "_resource_clients.actor",
+ "name": "runs",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the runs of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 935
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the runs of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3684,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "runs",
+ "parameters": [],
+ "type": {
+ "name": "RunCollectionClientAsync",
+ "type": "reference",
+ "target": "4037"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3685,
+ "module": "_resource_clients.actor",
+ "name": "default_build",
+ "parsedDocstring": {
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n",
+ "args": {
+ "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The resource client for the default build of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 942
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the default build of this Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3686,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "default_build",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3687,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "wait_for_finish",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3688,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "BuildClientAsync",
+ "type": "reference",
+ "target": "3293"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3689,
+ "module": "_resource_clients.actor",
+ "name": "last_run",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n",
+ "args": {
+ "status": "Consider only runs with this status.",
+ "origin": "Consider only runs started with this origin.\n"
+ },
+ "returns": "The resource client for the last run of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 980
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the last run of this Actor."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3690,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "last_run",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs with this status."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3691,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Consider only runs started with this origin.\n"
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3692,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "origin",
+ "type": {
+ "name": "RunOrigin | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "RunOrigin",
+ "target": "1897"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "RunClientAsync",
+ "type": "reference",
+ "target": "3200"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the versions of this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3693,
+ "module": "_resource_clients.actor",
+ "name": "versions",
+ "parsedDocstring": {
+ "text": "Retrieve a client for the versions of this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1007
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for the versions of this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3694,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "versions",
+ "parameters": [],
+ "type": {
+ "name": "ActorVersionCollectionClientAsync",
+ "type": "reference",
+ "target": "3396"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3695,
+ "module": "_resource_clients.actor",
+ "name": "version",
+ "parsedDocstring": {
+ "text": "Retrieve the client for the specified version of this Actor.\n",
+ "args": {
+ "version_number": "The version number for which to retrieve the resource client.\n"
+ },
+ "returns": "The resource client for the specified Actor version."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1011
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The resource client for the specified Actor version."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the client for the specified version of this Actor.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3696,
+ "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": 3697,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "version_number",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ],
+ "type": {
+ "name": "ActorVersionClientAsync",
+ "type": "reference",
+ "target": "2550"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3698,
+ "module": "_resource_clients.actor",
+ "name": "webhooks",
+ "parsedDocstring": {
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1025
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve a client for webhooks associated with this Actor."
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3699,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "webhooks",
+ "parameters": [],
+ "type": {
+ "name": "WebhookCollectionClientAsync",
+ "type": "reference",
+ "target": "3923"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Validate an input for the Actor that defines an input schema.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3700,
+ "module": "_resource_clients.actor",
+ "name": "validate_input",
+ "parsedDocstring": {
+ "text": "Validate an input for the Actor that defines an input schema.\n",
+ "args": {
+ "run_input": "The input to validate.",
+ "build_tag": "The Actor's build tag.",
+ "content_type": "The content type of the input.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "True if the input is valid, else raise an exception with validation error details."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 1029
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "True if the input is valid, else raise an exception with validation error details."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Validate an input for the Actor that defines an input schema.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3701,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "validate_input",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The input to validate."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": false
+ },
+ "id": 3702,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "run_input",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The Actor's build tag."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3703,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "build_tag",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the input."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3704,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3705,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4083,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3605,
+ 3673,
+ 3681,
+ 3658,
+ 3685,
+ 3641,
+ 3610,
+ 3689,
+ 3683,
+ 3644,
+ 3613,
+ 3700,
+ 3695,
+ 3693,
+ 3698
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4083
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3604,
+ "module": "_resource_clients.actor",
+ "name": "ActorClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 563
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3707,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 79
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3712,
+ "module": "_resource_clients.key_value_store",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved key-value store, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 92
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved key-value store, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3713,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3714,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "KeyValueStore",
+ "target": "647"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3715,
+ "module": "_resource_clients.key_value_store",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n",
+ "args": {
+ "name": "The new name for key-value store.",
+ "general_access": "Determines how others can access the key-value store.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 108
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated key-value store."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3716,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3717,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3718,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3719,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore",
+ "type": "reference",
+ "target": "647"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3720,
+ "module": "_resource_clients.key_value_store",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 130
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3721,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3722,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3723,
+ "module": "_resource_clients.key_value_store",
+ "name": "list_keys",
+ "parsedDocstring": {
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n",
+ "args": {
+ "limit": "Number of keys to be returned. Maximum value is 1000.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of keys in the key-value store matching the given arguments."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 140
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of keys in the key-value store matching the given arguments."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3724,
+ "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": 3725,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3726,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3727,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3728,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3729,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3730,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfKeys",
+ "type": "reference",
+ "target": "723"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3731,
+ "module": "_resource_clients.key_value_store",
+ "name": "iterate_keys",
+ "parsedDocstring": {
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n",
+ "args": {
+ "limit": "Maximum number of keys to return. By default there is no limit.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "signature": "Signature used to access the items.",
+ "chunk_size": "Maximum number of keys requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 183
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3732,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_keys",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of keys to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3733,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3734,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3735,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3736,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3737,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of keys requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3738,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3739,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreKey",
+ "target": "665"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3740,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 231
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3741,
+ "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": 3742,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3743,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3744,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3745,
+ "module": "_resource_clients.key_value_store",
+ "name": "record_exists",
+ "parsedDocstring": {
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n",
+ "args": {
+ "key": "Key of the record to check.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "True if the record exists, False otherwise."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 263
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "True if the record exists, False otherwise."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3746,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "record_exists",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to check."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3747,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3748,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3749,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record_as_bytes",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 290
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3750,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_record_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3751,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3752,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3753,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "contextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 3754,
+ "module": "_resource_clients.key_value_store",
+ "name": "stream_record",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 323
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3755,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "stream_record",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3756,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3757,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3758,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3759,
+ "module": "_resource_clients.key_value_store",
+ "name": "set_record",
+ "parsedDocstring": {
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n",
+ "args": {
+ "key": "The key of the record to save the value to.",
+ "value": "The value to save into the record.",
+ "content_type": "The content type of the saved value.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 361
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3760,
+ "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": 3761,
+ "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": 3762,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the saved value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3763,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3764,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3765,
+ "module": "_resource_clients.key_value_store",
+ "name": "delete_record",
+ "parsedDocstring": {
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n",
+ "args": {
+ "key": "The key of the record which to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 392
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3766,
+ "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": 3767,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3768,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3769,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n",
+ "args": {
+ "key": "The key for which the URL should be generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "A public URL that can be used to access the value of the given key in the KVS."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 408
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A public URL that can be used to access the value of the given key in the KVS."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3770,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get_record_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The key for which the URL should be generated."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3771,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3772,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3773,
+ "module": "_resource_clients.key_value_store",
+ "name": "create_keys_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n",
+ "args": {
+ "limit": "Number of keys to be returned. Maximum value is 1000.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "expires_in": "How long the signed URL should be valid from the time it is generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The public key-value store keys URL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 439
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The public key-value store keys URL."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3774,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "create_keys_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of keys to be returned. Maximum value is 1000."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3775,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3776,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3777,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3778,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the signed URL should be valid from the time it is generated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3779,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "expires_in",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3780,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4111,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3707,
+ 3773,
+ 3720,
+ 3765,
+ 3712,
+ 3740,
+ 3749,
+ 3769,
+ 3731,
+ 3723,
+ 3745,
+ 3759,
+ 3754,
+ 3715
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4111
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3706,
+ "module": "_resource_clients.key_value_store",
+ "name": "KeyValueStoreClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3782,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 505
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3787,
+ "module": "_resource_clients.key_value_store",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved key-value store, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 518
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved key-value store, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3788,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3789,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "KeyValueStore",
+ "target": "647"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3790,
+ "module": "_resource_clients.key_value_store",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n",
+ "args": {
+ "name": "The new name for key-value store.",
+ "general_access": "Determines how others can access the key-value store.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated key-value store."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 534
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated key-value store."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3791,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The new name for key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3792,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Determines how others can access the key-value store."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3793,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "general_access",
+ "type": {
+ "name": "GeneralAccess | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "GeneralAccess",
+ "target": "1895"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3794,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "KeyValueStore",
+ "type": "reference",
+ "target": "647"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3795,
+ "module": "_resource_clients.key_value_store",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 556
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3796,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3797,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3798,
+ "module": "_resource_clients.key_value_store",
+ "name": "list_keys",
+ "parsedDocstring": {
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n",
+ "args": {
+ "limit": "Number of keys to be returned. Maximum value is 1000.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of keys in the key-value store matching the given arguments."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 566
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of keys in the key-value store matching the given arguments."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3799,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list_keys",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of keys to be returned. Maximum value is 1000."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3800,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3801,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3802,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3803,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3804,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3805,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfKeys",
+ "type": "reference",
+ "target": "723"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3806,
+ "module": "_resource_clients.key_value_store",
+ "name": "iterate_keys",
+ "parsedDocstring": {
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n",
+ "args": {
+ "limit": "Maximum number of keys to return. By default there is no limit.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "signature": "Signature used to access the items.",
+ "chunk_size": "Maximum number of keys requested per API call when iterating across pages.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 609
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3807,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate_keys",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of keys to return. By default there is no limit."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3808,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3809,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3810,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3811,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3812,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Maximum number of keys requested per API call when iterating across pages."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3813,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "chunk_size",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3814,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "KeyValueStoreKey",
+ "target": "665"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3815,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 657
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3816,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_record",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3817,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3818,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3819,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3820,
+ "module": "_resource_clients.key_value_store",
+ "name": "record_exists",
+ "parsedDocstring": {
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n",
+ "args": {
+ "key": "Key of the record to check.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "True if the record exists, False otherwise."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 689
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "True if the record exists, False otherwise."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3821,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "record_exists",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to check."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3822,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3823,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "bool",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3824,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record_as_bytes",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 716
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3825,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_record_as_bytes",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3826,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3827,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3828,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "asynccontextmanager"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 3829,
+ "module": "_resource_clients.key_value_store",
+ "name": "stream_record",
+ "parsedDocstring": {
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n",
+ "args": {
+ "key": "Key of the record to retrieve.",
+ "signature": "Signature used to access the items.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 751
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3830,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "stream_record",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Key of the record to retrieve."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3831,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Signature used to access the items."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3832,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "signature",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3833,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3834,
+ "module": "_resource_clients.key_value_store",
+ "name": "set_record",
+ "parsedDocstring": {
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n",
+ "args": {
+ "key": "The key of the record to save the value to.",
+ "value": "The value to save into the record.",
+ "content_type": "The content type of the saved value.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 789
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3835,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "set_record",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The key of the record to save the value to."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3836,
+ "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": 3837,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "Any",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The content type of the saved value."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3838,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "content_type",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3839,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3840,
+ "module": "_resource_clients.key_value_store",
+ "name": "delete_record",
+ "parsedDocstring": {
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n",
+ "args": {
+ "key": "The key of the record which to delete.",
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 820
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3841,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete_record",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The key of the record which to delete."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3842,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3843,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3844,
+ "module": "_resource_clients.key_value_store",
+ "name": "get_record_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n",
+ "args": {
+ "key": "The key for which the URL should be generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "A public URL that can be used to access the value of the given key in the KVS."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 836
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A public URL that can be used to access the value of the given key in the KVS."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3845,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get_record_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The key for which the URL should be generated."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": false
+ },
+ "id": 3846,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "key",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3847,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3848,
+ "module": "_resource_clients.key_value_store",
+ "name": "create_keys_public_url",
+ "parsedDocstring": {
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n",
+ "args": {
+ "limit": "Number of keys to be returned. Maximum value is 1000.",
+ "exclusive_start_key": "All keys up to this one (including) are skipped from the result.",
+ "collection": "The name of the collection in store schema to list keys from.",
+ "prefix": "The prefix of the keys to be listed.",
+ "expires_in": "How long the signed URL should be valid from the time it is generated.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The public key-value store keys URL."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 867
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The public key-value store keys URL."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3849,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create_keys_public_url",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number of keys to be returned. Maximum value is 1000."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3850,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "All keys up to this one (including) are skipped from the result."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3851,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "exclusive_start_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the collection in store schema to list keys from."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3852,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "collection",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The prefix of the keys to be listed."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3853,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "prefix",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How long the signed URL should be valid from the time it is generated."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3854,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "expires_in",
+ "type": {
+ "name": "timedelta | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "timedelta"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'long'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3855,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4084,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3782,
+ 3848,
+ 3795,
+ 3840,
+ 3787,
+ 3815,
+ 3824,
+ 3844,
+ 3806,
+ 3798,
+ 3820,
+ 3834,
+ 3829,
+ 3790
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4084
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3781,
+ "module": "_resource_clients.key_value_store",
+ "name": "KeyValueStoreClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/key_value_store.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 498
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3857,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 21
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3862,
+ "module": "_resource_clients.actor_env_var",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor environment variable data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 34
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor environment variable data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3863,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3864,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3865,
+ "module": "_resource_clients.actor_env_var",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n",
+ "args": {
+ "is_secret": "Whether the environment variable is secret or not.",
+ "name": "The name of the environment variable.",
+ "value": "The value of the environment variable.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 50
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3866,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variable is secret or not."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3867,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_secret",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3868,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The value of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3869,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3870,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar",
+ "type": "reference",
+ "target": "592"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3871,
+ "module": "_resource_clients.actor_env_var",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 77
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3872,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3873,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4112,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3857,
+ 3871,
+ 3862,
+ 3865
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4112
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3856,
+ "module": "_resource_clients.actor_env_var",
+ "name": "ActorEnvVarClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 14
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3875,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 96
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3880,
+ "module": "_resource_clients.actor_env_var",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor environment variable data."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 109
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor environment variable data."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3881,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3882,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "EnvVar",
+ "target": "592"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3883,
+ "module": "_resource_clients.actor_env_var",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n",
+ "args": {
+ "is_secret": "Whether the environment variable is secret or not.",
+ "name": "The name of the environment variable.",
+ "value": "The value of the environment variable.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated Actor environment variable."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 125
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated Actor environment variable."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3884,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the environment variable is secret or not."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3885,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_secret",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The name of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3886,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "name",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The value of the environment variable."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3887,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "value",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3888,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "EnvVar",
+ "type": "reference",
+ "target": "592"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3889,
+ "module": "_resource_clients.actor_env_var",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 152
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3890,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3891,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4085,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3875,
+ 3889,
+ 3880,
+ 3883
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4085
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3874,
+ "module": "_resource_clients.actor_env_var",
+ "name": "ActorEnvVarClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/actor_env_var.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 89
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3893,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 32
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3897,
+ "module": "_resource_clients.webhook_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n",
+ "args": {
+ "limit": "How many webhooks to retrieve.",
+ "offset": "What webhook to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhooks in descending order based on their date of creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available webhooks matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 43
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available webhooks matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3898,
+ "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": 3899,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3900,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhooks in descending order based on their date of creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3901,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3902,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhooks",
+ "type": "reference",
+ "target": "845"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3903,
+ "module": "_resource_clients.webhook_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n",
+ "args": {
+ "limit": "How many webhooks to retrieve.",
+ "offset": "What webhook to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhooks in descending order based on their date of creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 67
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3904,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhooks to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3905,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3906,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhooks in descending order based on their date of creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3907,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3908,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookShort",
+ "target": "1501"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3909,
+ "module": "_resource_clients.webhook_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n",
+ "args": {
+ "event_types": "List of event types that should trigger the webhook. At least one is required.",
+ "request_url": "URL that will be invoked once the webhook is triggered.",
+ "payload_template": "Specification of the payload that will be sent to request_url.",
+ "headers_template": "Headers that will be sent to the request_url.",
+ "actor_id": "Id of the Actor whose runs should trigger the webhook.",
+ "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.",
+ "actor_run_id": "Id of the Actor run which should trigger the webhook.",
+ "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.",
+ "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.",
+ "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.",
+ "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 97
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created webhook."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3910,
+ "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": 3911,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_types",
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL that will be invoked once the webhook is triggered."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3912,
+ "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": 3913,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "payload_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Headers that will be sent to the request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3914,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3915,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor task whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3916,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_task_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor run which should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3917,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_run_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should ignore SSL errors returned by request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3918,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ignore_ssl_errors",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should retry sending the payload to request_url upon failure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3919,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "do_not_retry",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3920,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "idempotency_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3921,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_ad_hoc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3922,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook",
+ "type": "reference",
+ "target": "1438"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4113,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3893,
+ 3909,
+ 3903,
+ 3897
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4113
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3892,
+ "module": "_resource_clients.webhook_collection",
+ "name": "WebhookCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 25
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3924,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 165
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3928,
+ "module": "_resource_clients.webhook_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n",
+ "args": {
+ "limit": "How many webhooks to retrieve.",
+ "offset": "What webhook to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhooks in descending order based on their date of creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The list of available webhooks matching the specified filters."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 176
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The list of available webhooks matching the specified filters."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3929,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhooks to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3930,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3931,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhooks in descending order based on their date of creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3932,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3933,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfWebhooks",
+ "type": "reference",
+ "target": "845"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3934,
+ "module": "_resource_clients.webhook_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n",
+ "args": {
+ "limit": "How many webhooks to retrieve.",
+ "offset": "What webhook to include as first when retrieving the list.",
+ "desc": "Whether to sort the webhooks in descending order based on their date of creation.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 200
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3935,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many webhooks to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3936,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What webhook to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3937,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the webhooks in descending order based on their date of creation."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3938,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3939,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookShort",
+ "target": "1501"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "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": 3940,
+ "module": "_resource_clients.webhook_collection",
+ "name": "create",
+ "parsedDocstring": {
+ "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n",
+ "args": {
+ "event_types": "List of event types that should trigger the webhook. At least one is required.",
+ "request_url": "URL that will be invoked once the webhook is triggered.",
+ "payload_template": "Specification of the payload that will be sent to request_url.",
+ "headers_template": "Headers that will be sent to the request_url.",
+ "actor_id": "Id of the Actor whose runs should trigger the webhook.",
+ "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.",
+ "actor_run_id": "Id of the Actor run which should trigger the webhook.",
+ "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.",
+ "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.",
+ "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.",
+ "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The created webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 230
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The created webhook."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3941,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "create",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of event types that should trigger the webhook. At least one is required."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3942,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_types",
+ "type": {
+ "name": "list",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL that will be invoked once the webhook is triggered."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3943,
+ "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": 3944,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "payload_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Headers that will be sent to the request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3945,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3946,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor task whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3947,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_task_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor run which should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3948,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_run_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should ignore SSL errors returned by request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3949,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ignore_ssl_errors",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should retry sending the payload to request_url upon failure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3950,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "do_not_retry",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3951,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "idempotency_key",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3952,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_ad_hoc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3953,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook",
+ "type": "reference",
+ "target": "1438"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4086,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3924,
+ 3940,
+ 3934,
+ 3928
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4086
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3923,
+ "module": "_resource_clients.webhook_collection",
+ "name": "WebhookCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 158
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3955,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 33
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "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": 3960,
+ "module": "_resource_clients.webhook",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 46
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3961,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3962,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Webhook",
+ "target": "1438"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3963,
+ "module": "_resource_clients.webhook",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n",
+ "args": {
+ "event_types": "List of event types that should trigger the webhook. At least one is required.",
+ "request_url": "URL that will be invoked once the webhook is triggered.",
+ "payload_template": "Specification of the payload that will be sent to request_url.",
+ "headers_template": "Headers that will be sent to the request_url.",
+ "actor_id": "Id of the Actor whose runs should trigger the webhook.",
+ "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.",
+ "actor_run_id": "Id of the Actor run which should trigger the webhook.",
+ "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.",
+ "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.",
+ "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 62
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated webhook."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3964,
+ "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": 3965,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_types",
+ "type": {
+ "name": "list[WebhookEventType] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL that will be invoked once the webhook is triggered."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3966,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specification of the payload that will be sent to request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3967,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "payload_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Headers that will be sent to the request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3968,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3969,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor task whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3970,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_task_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor run which should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3971,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_run_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should ignore SSL errors returned by request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3972,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ignore_ssl_errors",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should retry sending the payload to request_url upon failure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3973,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "do_not_retry",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3974,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_ad_hoc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3975,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook",
+ "type": "reference",
+ "target": "1438"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3976,
+ "module": "_resource_clients.webhook",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 115
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3977,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3978,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3979,
+ "module": "_resource_clients.webhook",
+ "name": "test",
+ "parsedDocstring": {
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The webhook dispatch created by the test."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 125
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The webhook dispatch created by the test."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3980,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "test",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3981,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch",
+ "type": "reference",
+ "target": "1474"
+ }
+ }
+ ]
+ },
+ {
+ "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": 3982,
+ "module": "_resource_clients.webhook",
+ "name": "dispatches",
+ "parsedDocstring": {
+ "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n",
+ "returns": "A client allowing access to dispatches of this webhook using its list method."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 151
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to dispatches of this webhook using its list method."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3983,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "dispatches",
+ "parameters": [],
+ "type": {
+ "name": "WebhookDispatchCollectionClient",
+ "type": "reference",
+ "target": "2326"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4114,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3955,
+ 3976,
+ 3982,
+ 3960,
+ 3979,
+ 3963
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4114
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3954,
+ "module": "_resource_clients.webhook",
+ "name": "WebhookClient",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 26
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3985,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 173
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "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": 3990,
+ "module": "_resource_clients.webhook",
+ "name": "get",
+ "parsedDocstring": {
+ "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved webhook, or None if it does not exist."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 186
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved webhook, or None if it does not exist."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3991,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "get",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3992,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "Webhook",
+ "target": "1438"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 3993,
+ "module": "_resource_clients.webhook",
+ "name": "update",
+ "parsedDocstring": {
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n",
+ "args": {
+ "event_types": "List of event types that should trigger the webhook. At least one is required.",
+ "request_url": "URL that will be invoked once the webhook is triggered.",
+ "payload_template": "Specification of the payload that will be sent to request_url.",
+ "headers_template": "Headers that will be sent to the request_url.",
+ "actor_id": "Id of the Actor whose runs should trigger the webhook.",
+ "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.",
+ "actor_run_id": "Id of the Actor run which should trigger the webhook.",
+ "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.",
+ "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.",
+ "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The updated webhook."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 202
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The updated webhook."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3994,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "update",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List of event types that should trigger the webhook. At least one is required."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3995,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "event_types",
+ "type": {
+ "name": "list[WebhookEventType] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "WebhookEventType",
+ "target": "1902"
+ }
+ ],
+ "target": "2297"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "URL that will be invoked once the webhook is triggered."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3996,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "request_url",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Specification of the payload that will be sent to request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3997,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "payload_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Headers that will be sent to the request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3998,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "headers_template",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3999,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor task whose runs should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4000,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_task_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Id of the Actor run which should trigger the webhook."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4001,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "actor_run_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should ignore SSL errors returned by request_url."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4002,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "ignore_ssl_errors",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the webhook should retry sending the payload to request_url upon failure."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4003,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "do_not_retry",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4004,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "is_ad_hoc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4005,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Webhook",
+ "type": "reference",
+ "target": "1438"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4006,
+ "module": "_resource_clients.webhook",
+ "name": "delete",
+ "parsedDocstring": {
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 255
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4007,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "delete",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request."
+ }
+ ]
+ },
+ "defaultValue": "'short'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4008,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4009,
+ "module": "_resource_clients.webhook",
+ "name": "test",
+ "parsedDocstring": {
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n",
+ "args": {
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The webhook dispatch created by the test."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 265
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The webhook dispatch created by the test."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4010,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "test",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4011,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "WebhookDispatch",
+ "type": "reference",
+ "target": "1474"
+ }
+ }
+ ]
+ },
+ {
+ "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": 4012,
+ "module": "_resource_clients.webhook",
+ "name": "dispatches",
+ "parsedDocstring": {
+ "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n",
+ "returns": "A client allowing access to dispatches of this webhook using its list method."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 291
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "A client allowing access to dispatches of this webhook using its list method."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4013,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "dispatches",
+ "parameters": [],
+ "type": {
+ "name": "WebhookDispatchCollectionClientAsync",
+ "type": "reference",
+ "target": "2343"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4087,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 3985,
+ 4006,
+ 4012,
+ 3990,
+ 4009,
+ 3993
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4087
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 3984,
+ "module": "_resource_clients.webhook",
+ "name": "WebhookClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/webhook.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 166
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4015,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 27
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3484,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3485,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3486,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3487,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClient",
+ "type": "reference",
+ "target": "1934"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3488,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3489,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistry",
+ "type": "reference",
+ "target": "1808"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3490,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3491,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClient.__init__",
+ "target": 3483,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4019,
+ "module": "_resource_clients.run_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n",
+ "args": {
+ "limit": "How many runs to retrieve.",
+ "offset": "What run to include as first when retrieving the list.",
+ "desc": "Whether to sort the runs in descending order based on their start date.",
+ "status": "Retrieve only runs with the provided statuses.",
+ "started_before": "Only return runs started before this date (inclusive).",
+ "started_after": "Only return runs started after this date (inclusive).",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor runs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 38
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor runs."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4020,
+ "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": 4021,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What run to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4022,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the runs in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4023,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve only runs with the provided statuses."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4024,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | list[ActorJobStatus] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started before this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4025,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_before",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started after this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4026,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_after",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4027,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRuns",
+ "type": "reference",
+ "target": "830"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4028,
+ "module": "_resource_clients.run_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n",
+ "args": {
+ "limit": "How many runs to retrieve.",
+ "offset": "What run to include as first when retrieving the list.",
+ "desc": "Whether to sort the runs in descending order based on their start date.",
+ "status": "Retrieve only runs with the provided statuses.",
+ "started_before": "Only return runs started before this date (inclusive).",
+ "started_after": "Only return runs started after this date (inclusive).",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 82
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4029,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many runs to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4030,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What run to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4031,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the runs in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4032,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve only runs with the provided statuses."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4033,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | list[ActorJobStatus] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started before this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4034,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_before",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started after this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4035,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_after",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4036,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "Iterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunShort",
+ "target": "1090"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4115,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4015,
+ 4028,
+ 4019
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4115
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 4014,
+ "module": "_resource_clients.run_collection",
+ "name": "RunCollectionClient",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 20
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClient",
+ "target": "3482",
+ "type": "reference"
+ }
+ ]
+ },
+ {
+ "kind": 128,
+ "kindString": "Class",
+ "children": [
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4038,
+ "module": "_resource_clients._resource_client",
+ "name": "__init__",
+ "parsedDocstring": {
+ "text": "Initialize the resource client.\n",
+ "args": {
+ "base_url": "API base URL.",
+ "public_base_url": "Public CDN base URL.",
+ "http_client": "HTTP client for making requests.",
+ "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').",
+ "client_registry": "Bundle of client classes for dependency injection.",
+ "resource_id": "Optional resource ID for single-resource clients.",
+ "params": "Optional default parameters for all requests."
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 136
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Initialize the resource client.\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 3494,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "__init__",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "API base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3495,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Public CDN base URL."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3496,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "public_base_url",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "HTTP client for making requests."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3497,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "http_client",
+ "type": {
+ "name": "HttpClientAsync",
+ "type": "reference",
+ "target": "1945"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Resource endpoint path (e.g., 'actors', 'datasets')."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3498,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_path",
+ "type": {
+ "name": "str",
+ "type": "reference"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Bundle of client classes for dependency injection."
+ }
+ ]
+ },
+ "flags": {
+ "isOptional": false,
+ "keyword-only": true
+ },
+ "id": 3499,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "client_registry",
+ "type": {
+ "name": "ClientRegistryAsync",
+ "type": "reference",
+ "target": "1836"
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional resource ID for single-resource clients."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3500,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "resource_id",
+ "type": {
+ "name": "str | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Optional default parameters for all requests."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 3501,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "params",
+ "type": {
+ "name": "dict | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "dict"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ }
+ ],
+ "type": {
+ "name": "None",
+ "type": "literal",
+ "value": null
+ },
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ }
+ ],
+ "overwrites": {
+ "name": "ResourceClientAsync.__init__",
+ "target": 3493,
+ "type": "reference"
+ }
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4042,
+ "module": "_resource_clients.run_collection",
+ "name": "list",
+ "parsedDocstring": {
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n",
+ "args": {
+ "limit": "How many runs to retrieve.",
+ "offset": "What run to include as first when retrieving the list.",
+ "desc": "Whether to sort the runs in descending order based on their start date.",
+ "status": "Retrieve only runs with the provided statuses.",
+ "started_before": "Only return runs started before this date (inclusive).",
+ "started_after": "Only return runs started after this date (inclusive).",
+ "timeout": "Timeout for the API HTTP request.\n"
+ },
+ "returns": "The retrieved Actor runs."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 147
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "blockTags": [
+ {
+ "content": [
+ {
+ "kind": "text",
+ "text": "The retrieved Actor runs."
+ }
+ ],
+ "tag": "@returns"
+ }
+ ],
+ "summary": [
+ {
+ "kind": "text",
+ "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4043,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [
+ "async"
+ ],
+ "name": "list",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many runs to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4044,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What run to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4045,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the runs in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4046,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve only runs with the provided statuses."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4047,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | list[ActorJobStatus] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started before this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4048,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_before",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started after this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4049,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_after",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4050,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "ListOfRuns",
+ "type": "reference",
+ "target": "830"
+ }
+ }
+ ]
+ },
+ {
+ "kind": 2048,
+ "kindString": "Method",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "decorations": [],
+ "flags": {},
+ "groups": [],
+ "id": 4051,
+ "module": "_resource_clients.run_collection",
+ "name": "iterate",
+ "parsedDocstring": {
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n",
+ "args": {
+ "limit": "How many runs to retrieve.",
+ "offset": "What run to include as first when retrieving the list.",
+ "desc": "Whether to sort the runs in descending order based on their start date.",
+ "status": "Retrieve only runs with the provided statuses.",
+ "started_before": "Only return runs started before this date (inclusive).",
+ "started_after": "Only return runs started after this date (inclusive).",
+ "timeout": "Timeout for the API HTTP request.\n"
+ }
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 191
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "signatures": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n"
+ }
+ ]
+ },
+ "flags": {},
+ "id": 4052,
+ "kind": 4096,
+ "kindString": "Call signature",
+ "modifiers": [],
+ "name": "iterate",
+ "parameters": [
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "How many runs to retrieve."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4053,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "limit",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "What run to include as first when retrieving the list."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4054,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "offset",
+ "type": {
+ "name": "int | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "int"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether to sort the runs in descending order based on their start date."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4055,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "desc",
+ "type": {
+ "name": "bool | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "bool"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Retrieve only runs with the provided statuses."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4056,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "status",
+ "type": {
+ "name": "ActorJobStatus | list[ActorJobStatus] | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ },
+ {
+ "type": "reference",
+ "name": "list",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "ActorJobStatus",
+ "target": "1892"
+ }
+ ],
+ "target": "2297"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started before this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4057,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_before",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Only return runs started after this date (inclusive)."
+ }
+ ]
+ },
+ "defaultValue": "None",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4058,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "started_after",
+ "type": {
+ "name": "str | datetime | None",
+ "type": "union",
+ "types": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "name": "str"
+ },
+ {
+ "type": "reference",
+ "name": "datetime"
+ }
+ ]
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ },
+ {
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Timeout for the API HTTP request.\n"
+ }
+ ]
+ },
+ "defaultValue": "'medium'",
+ "flags": {
+ "isOptional": true,
+ "keyword-only": true
+ },
+ "id": 4059,
+ "kind": 32768,
+ "kindString": "Parameter",
+ "name": "timeout",
+ "type": {
+ "name": "Timeout",
+ "type": "reference",
+ "target": "13"
+ }
+ }
+ ],
+ "type": {
+ "name": "AsyncIterator",
+ "type": "reference",
+ "typeArguments": [
+ {
+ "type": "reference",
+ "name": "RunShort",
+ "target": "1090"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "kind": 1024,
+ "kindString": "Property",
+ "children": [],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Get the resource ID."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "name": "property"
+ }
+ ],
+ "flags": {},
+ "groups": [],
+ "id": 4088,
+ "module": "_resource_clients._resource_client",
+ "name": "resource_id",
+ "parsedDocstring": {
+ "text": "Get the resource ID."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/_resource_client.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 72
+ }
+ ],
+ "type": {
+ "name": "str | None",
+ "type": "reference"
+ },
+ "inheritedFrom": {
+ "name": "ResourceClientBase.resource_id",
+ "target": 3481,
+ "type": "reference"
+ }
+ }
+ ],
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ }
+ ]
+ },
+ "decorations": [
+ {
+ "args": "('Resource clients')",
+ "name": "docs_group"
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 4038,
+ 4051,
+ 4042
+ ],
+ "title": "Methods"
+ },
+ {
+ "children": [
+ 4088
+ ],
+ "title": "Properties"
+ }
+ ],
+ "id": 4037,
+ "module": "_resource_clients.run_collection",
+ "name": "RunCollectionClientAsync",
+ "parsedDocstring": {
+ "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class."
+ },
+ "sources": [
+ {
+ "character": 1,
+ "fileName": "/src/apify_client/_resource_clients/run_collection.py",
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561",
+ "line": 129
+ }
+ ],
+ "type": {
+ "name": "Undefined",
+ "type": "reference"
+ },
+ "extendedTypes": [
+ {
+ "name": "ResourceClientAsync",
+ "target": "3492",
+ "type": "reference"
+ }
+ ]
+ }
+ ],
+ "flags": {},
+ "groups": [
+ {
+ "children": [
+ 1534,
+ 1614
+ ],
+ "title": "Apify API clients"
+ },
+ {
+ "children": [
+ 17,
+ 16,
+ 32,
+ 30,
+ 28,
+ 35,
+ 31,
+ 33,
+ 34,
+ 29
+ ],
+ "title": "Errors"
+ },
+ {
+ "children": [
+ 1934,
+ 1945,
+ 1922,
+ 1903,
+ 1958,
+ 1980
+ ],
+ "title": "HTTP clients"
+ },
+ {
+ "children": [
+ 187,
+ 199,
+ 232,
+ 240,
+ 257,
+ 260,
+ 263,
+ 266,
+ 275,
+ 285,
+ 192,
+ 302,
+ 299,
+ 308,
+ 311,
+ 315,
+ 318,
+ 322,
+ 330,
+ 349,
+ 355,
+ 358,
+ 382,
+ 370,
+ 376,
+ 379,
+ 387,
+ 394,
+ 398,
+ 408,
+ 424,
+ 435,
+ 443,
+ 456,
+ 473,
+ 478,
+ 497,
+ 503,
+ 519,
+ 539,
+ 522,
+ 527,
+ 530,
+ 533,
+ 542,
+ 588,
+ 547,
+ 550,
+ 558,
+ 562,
+ 566,
+ 573,
+ 585,
+ 589,
+ 592,
+ 597,
+ 599,
+ 602,
+ 606,
+ 609,
+ 613,
+ 617,
+ 622,
+ 627,
+ 630,
+ 633,
+ 640,
+ 643,
+ 647,
+ 665,
+ 670,
+ 681,
+ 673,
+ 684,
+ 698,
+ 812,
+ 701,
+ 704,
+ 815,
+ 707,
+ 818,
+ 710,
+ 713,
+ 717,
+ 723,
+ 731,
+ 822,
+ 720,
+ 826,
+ 734,
+ 737,
+ 744,
+ 830,
+ 747,
+ 833,
+ 750,
+ 836,
+ 839,
+ 753,
+ 756,
+ 760,
+ 842,
+ 763,
+ 845,
+ 766,
+ 769,
+ 777,
+ 786,
+ 792,
+ 799,
+ 802,
+ 805,
+ 848,
+ 853,
+ 880,
+ 886,
+ 893,
+ 896,
+ 899,
+ 907,
+ 910,
+ 914,
+ 919,
+ 926,
+ 929,
+ 932,
+ 934,
+ 936,
+ 951,
+ 938,
+ 954,
+ 968,
+ 960,
+ 964,
+ 970,
+ 973,
+ 990,
+ 996,
+ 1024,
+ 999,
+ 1017,
+ 1027,
+ 1032,
+ 1035,
+ 1037,
+ 1069,
+ 1072,
+ 1079,
+ 1087,
+ 1090,
+ 1107,
+ 1126,
+ 1129,
+ 1143,
+ 1197,
+ 1157,
+ 1164,
+ 1170,
+ 1174,
+ 1179,
+ 1184,
+ 1203,
+ 1213,
+ 1219,
+ 1224,
+ 1229,
+ 1232,
+ 1235,
+ 1238,
+ 1241,
+ 1246,
+ 1250,
+ 1255,
+ 1258,
+ 1279,
+ 1285,
+ 1301,
+ 1303,
+ 1311,
+ 1314,
+ 1326,
+ 1329,
+ 1332,
+ 1335,
+ 1338,
+ 1341,
+ 1344,
+ 1362,
+ 1366,
+ 1370,
+ 1374,
+ 1377,
+ 1383,
+ 1384,
+ 1391,
+ 1395,
+ 1402,
+ 1413,
+ 1417,
+ 1424,
+ 1435,
+ 1438,
+ 1456,
+ 1461,
+ 1474,
+ 1485,
+ 1486,
+ 1492,
+ 1498,
+ 1501,
+ 1519,
+ 1522
+ ],
+ "title": "Models"
+ },
+ {
+ "children": [
+ 2910,
+ 1791,
+ 1774,
+ 44,
+ 61
+ ],
+ "title": "Other"
+ },
+ {
+ "children": [
+ 3502,
+ 3604,
+ 2360,
+ 2406,
+ 3856,
+ 3874,
+ 2292,
+ 2309,
+ 2522,
+ 2550,
+ 3373,
+ 3396,
+ 3269,
+ 3293,
+ 2876,
+ 2893,
+ 2917,
+ 3024,
+ 3419,
+ 3445,
+ 3706,
+ 3781,
+ 2470,
+ 2496,
+ 2258,
+ 2275,
+ 2094,
+ 2176,
+ 2578,
+ 2603,
+ 3482,
+ 3492,
+ 3131,
+ 3200,
+ 4014,
+ 4037,
+ 2002,
+ 2028,
+ 3317,
+ 3345,
+ 2696,
+ 2721,
+ 2746,
+ 2811,
+ 2628,
+ 2662,
+ 2054,
+ 2074,
+ 3954,
+ 3984,
+ 3892,
+ 3923,
+ 2452,
+ 2461,
+ 2326,
+ 2343
+ ],
+ "title": "Resource clients"
+ },
+ {
+ "children": [
+ 90,
+ 78,
+ 104,
+ 102,
+ 111,
+ 119,
+ 116,
+ 125,
+ 122,
+ 106,
+ 138,
+ 134,
+ 154,
+ 142,
+ 171,
+ 166
+ ],
+ "title": "Typed dicts"
+ }
+ ],
+ "id": 0,
+ "kind": 1,
+ "kindString": "Project",
+ "name": "apify-client",
+ "sources": [
+ {
+ "character": 0,
+ "fileName": "src/index.ts",
+ "line": 1,
+ "gitRevision": "e73f7a2a6fa7ad23b52143d6b9ffac0963ea2561"
+ }
+ ],
+ "symbolIdMap": {
+ "1": {
+ "qualifiedName": "ClientStatistics",
+ "sourceFileName": "/src/apify_client/_statistics.py"
+ },
+ "2": {
+ "qualifiedName": "calls",
+ "sourceFileName": "/src/apify_client/_statistics.py"
+ },
+ "3": {
+ "qualifiedName": "requests",
+ "sourceFileName": "/src/apify_client/_statistics.py"
+ },
+ "4": {
+ "qualifiedName": "rate_limit_errors",
+ "sourceFileName": "/src/apify_client/_statistics.py"
+ },
+ "5": {
+ "qualifiedName": "add_rate_limit_error",
+ "sourceFileName": "/src/apify_client/_statistics.py"
+ },
+ "8": {
+ "qualifiedName": "GroupName",
+ "sourceFileName": "/src/apify_client/_docs.py"
+ },
+ "9": {
+ "qualifiedName": "T",
+ "sourceFileName": "/src/apify_client/_docs.py"
+ },
+ "10": {
+ "qualifiedName": "docs_group",
+ "sourceFileName": "/src/apify_client/_docs.py"
+ },
+ "13": {
+ "qualifiedName": "Timeout",
+ "sourceFileName": "/src/apify_client/types.py"
+ },
+ "14": {
+ "qualifiedName": "WebhooksList",
+ "sourceFileName": "/src/apify_client/types.py"
+ },
+ "15": {
+ "qualifiedName": "JsonSerializable",
+ "sourceFileName": "/src/apify_client/types.py"
+ },
+ "16": {
+ "qualifiedName": "ApifyClientError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "17": {
+ "qualifiedName": "ApifyApiError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "18": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "23": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "28": {
+ "qualifiedName": "InvalidRequestError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "29": {
+ "qualifiedName": "UnauthorizedError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "30": {
+ "qualifiedName": "ForbiddenError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "31": {
+ "qualifiedName": "NotFoundError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "32": {
+ "qualifiedName": "ConflictError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "33": {
+ "qualifiedName": "RateLimitError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "34": {
+ "qualifiedName": "ServerError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "35": {
+ "qualifiedName": "InvalidResponseBodyError",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "36": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "39": {
+ "qualifiedName": "StreamedLogBase",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "40": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "44": {
+ "qualifiedName": "StreamedLog",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "45": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "50": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "52": {
+ "qualifiedName": "stop",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "54": {
+ "qualifiedName": "__enter__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "56": {
+ "qualifiedName": "__exit__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "61": {
+ "qualifiedName": "StreamedLogAsync",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "62": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "67": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "69": {
+ "qualifiedName": "stop",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "71": {
+ "qualifiedName": "__aenter__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "73": {
+ "qualifiedName": "__aexit__",
+ "sourceFileName": "/src/apify_client/_streamed_log.py"
+ },
+ "78": {
+ "qualifiedName": "RequestBaseDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "79": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "80": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "81": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "82": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "83": {
+ "qualifiedName": "loaded_url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "84": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "85": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "86": {
+ "qualifiedName": "user_data",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "87": {
+ "qualifiedName": "no_retry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "88": {
+ "qualifiedName": "error_messages",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "89": {
+ "qualifiedName": "handled_at",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "90": {
+ "qualifiedName": "RequestBaseCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "91": {
+ "qualifiedName": "uniqueKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "92": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "93": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "94": {
+ "qualifiedName": "retryCount",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "95": {
+ "qualifiedName": "loadedUrl",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "96": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "97": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "98": {
+ "qualifiedName": "userData",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "99": {
+ "qualifiedName": "noRetry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "100": {
+ "qualifiedName": "errorMessages",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "101": {
+ "qualifiedName": "handledAt",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "102": {
+ "qualifiedName": "RequestDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "103": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "104": {
+ "qualifiedName": "RequestCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "105": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "106": {
+ "qualifiedName": "RequestDraftDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "107": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "108": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "109": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "110": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "111": {
+ "qualifiedName": "RequestDraftCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "112": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "113": {
+ "qualifiedName": "uniqueKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "114": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "115": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "116": {
+ "qualifiedName": "RequestDraftDeleteByIdDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "117": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "118": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "119": {
+ "qualifiedName": "RequestDraftDeleteByIdCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "120": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "121": {
+ "qualifiedName": "uniqueKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "122": {
+ "qualifiedName": "RequestDraftDeleteByUniqueKeyDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "123": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "124": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "125": {
+ "qualifiedName": "RequestDraftDeleteByUniqueKeyCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "126": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "127": {
+ "qualifiedName": "uniqueKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "128": {
+ "qualifiedName": "RequestDraftDeleteDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "129": {
+ "qualifiedName": "RequestDraftDeleteCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "130": {
+ "qualifiedName": "RequestUserDataDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "131": {
+ "qualifiedName": "RequestUserDataCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "132": {
+ "qualifiedName": "TaskInputDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "133": {
+ "qualifiedName": "TaskInputCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "134": {
+ "qualifiedName": "WebhookConditionDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "135": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "136": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "137": {
+ "qualifiedName": "actor_run_id",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "138": {
+ "qualifiedName": "WebhookConditionCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "139": {
+ "qualifiedName": "actorId",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "140": {
+ "qualifiedName": "actorTaskId",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "141": {
+ "qualifiedName": "actorRunId",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "142": {
+ "qualifiedName": "WebhookCreateDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "143": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "144": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "145": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "146": {
+ "qualifiedName": "idempotency_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "147": {
+ "qualifiedName": "ignore_ssl_errors",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "148": {
+ "qualifiedName": "do_not_retry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "149": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "150": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "151": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "152": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "153": {
+ "qualifiedName": "should_interpolate_strings",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "154": {
+ "qualifiedName": "WebhookCreateCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "155": {
+ "qualifiedName": "isAdHoc",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "156": {
+ "qualifiedName": "eventTypes",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "157": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "158": {
+ "qualifiedName": "idempotencyKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "159": {
+ "qualifiedName": "ignoreSslErrors",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "160": {
+ "qualifiedName": "doNotRetry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "161": {
+ "qualifiedName": "requestUrl",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "162": {
+ "qualifiedName": "payloadTemplate",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "163": {
+ "qualifiedName": "headersTemplate",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "164": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "165": {
+ "qualifiedName": "shouldInterpolateStrings",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "166": {
+ "qualifiedName": "WebhookRepresentationDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "167": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "168": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "169": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "170": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "171": {
+ "qualifiedName": "WebhookRepresentationCamelDict",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "172": {
+ "qualifiedName": "eventTypes",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "173": {
+ "qualifiedName": "requestUrl",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "174": {
+ "qualifiedName": "payloadTemplate",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "175": {
+ "qualifiedName": "headersTemplate",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "176": {
+ "qualifiedName": "DEFAULT_API_URL",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "177": {
+ "qualifiedName": "API_VERSION",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "178": {
+ "qualifiedName": "DEFAULT_TIMEOUT_SHORT",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "179": {
+ "qualifiedName": "DEFAULT_TIMEOUT_MEDIUM",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "180": {
+ "qualifiedName": "DEFAULT_TIMEOUT_LONG",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "181": {
+ "qualifiedName": "DEFAULT_TIMEOUT_MAX",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "182": {
+ "qualifiedName": "DEFAULT_MAX_RETRIES",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "183": {
+ "qualifiedName": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "184": {
+ "qualifiedName": "DEFAULT_WAIT_FOR_FINISH",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "185": {
+ "qualifiedName": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "186": {
+ "qualifiedName": "OVERRIDABLE_DEFAULT_HEADERS",
+ "sourceFileName": "/src/apify_client/_consts.py"
+ },
+ "187": {
+ "qualifiedName": "AccountLimits",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "188": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "189": {
+ "qualifiedName": "monthly_usage_cycle",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "190": {
+ "qualifiedName": "limits",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "191": {
+ "qualifiedName": "current",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "192": {
+ "qualifiedName": "ActVersion",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "193": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "194": {
+ "qualifiedName": "source_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "195": {
+ "qualifiedName": "build_tag",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "196": {
+ "qualifiedName": "version_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "197": {
+ "qualifiedName": "git_repo_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "198": {
+ "qualifiedName": "source_files",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "199": {
+ "qualifiedName": "Actor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "200": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "201": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "202": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "203": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "204": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "205": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "206": {
+ "qualifiedName": "restart_on_error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "207": {
+ "qualifiedName": "is_public",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "208": {
+ "qualifiedName": "actor_permission_level",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "209": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "210": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "211": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "212": {
+ "qualifiedName": "versions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "213": {
+ "qualifiedName": "pricing_infos",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "214": {
+ "qualifiedName": "default_run_options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "215": {
+ "qualifiedName": "example_run_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "216": {
+ "qualifiedName": "is_deprecated",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "217": {
+ "qualifiedName": "deployment_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "218": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "219": {
+ "qualifiedName": "tagged_builds",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "220": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "221": {
+ "qualifiedName": "readme_summary",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "222": {
+ "qualifiedName": "seo_title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "223": {
+ "qualifiedName": "seo_description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "224": {
+ "qualifiedName": "picture_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "225": {
+ "qualifiedName": "standby_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "226": {
+ "qualifiedName": "notice",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "227": {
+ "qualifiedName": "categories",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "228": {
+ "qualifiedName": "is_critical",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "229": {
+ "qualifiedName": "is_generic",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "230": {
+ "qualifiedName": "is_source_code_hidden",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "231": {
+ "qualifiedName": "has_no_dataset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "232": {
+ "qualifiedName": "ActorChargeEvent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "233": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "234": {
+ "qualifiedName": "event_title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "235": {
+ "qualifiedName": "event_description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "236": {
+ "qualifiedName": "event_price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "237": {
+ "qualifiedName": "event_tiered_pricing_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "238": {
+ "qualifiedName": "is_primary_event",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "239": {
+ "qualifiedName": "is_one_time_event",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "240": {
+ "qualifiedName": "ActorDefinition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "241": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "242": {
+ "qualifiedName": "actor_specification",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "243": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "244": {
+ "qualifiedName": "version",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "245": {
+ "qualifiedName": "build_tag",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "246": {
+ "qualifiedName": "environment_variables",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "247": {
+ "qualifiedName": "dockerfile",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "248": {
+ "qualifiedName": "docker_context_dir",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "249": {
+ "qualifiedName": "readme",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "250": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "251": {
+ "qualifiedName": "changelog",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "252": {
+ "qualifiedName": "storages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "253": {
+ "qualifiedName": "default_memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "254": {
+ "qualifiedName": "min_memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "255": {
+ "qualifiedName": "max_memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "256": {
+ "qualifiedName": "uses_standby_mode",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "257": {
+ "qualifiedName": "ActorResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "258": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "259": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "260": {
+ "qualifiedName": "ActorRunFailedError",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "261": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "262": {
+ "qualifiedName": "error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "263": {
+ "qualifiedName": "ActorRunTimeoutExceededError",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "264": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "265": {
+ "qualifiedName": "error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "266": {
+ "qualifiedName": "ActorShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "267": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "268": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "269": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "270": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "271": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "272": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "273": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "274": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "275": {
+ "qualifiedName": "ActorStandby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "276": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "277": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "278": {
+ "qualifiedName": "desired_requests_per_actor_run",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "279": {
+ "qualifiedName": "max_requests_per_actor_run",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "280": {
+ "qualifiedName": "idle_timeout_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "281": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "282": {
+ "qualifiedName": "memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "283": {
+ "qualifiedName": "disable_standby_fields_override",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "284": {
+ "qualifiedName": "should_pass_actor_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "285": {
+ "qualifiedName": "ActorStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "286": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "287": {
+ "qualifiedName": "total_builds",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "288": {
+ "qualifiedName": "total_runs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "289": {
+ "qualifiedName": "total_users",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "290": {
+ "qualifiedName": "total_users7_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "291": {
+ "qualifiedName": "total_users30_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "292": {
+ "qualifiedName": "total_users90_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "293": {
+ "qualifiedName": "total_metamorphs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "294": {
+ "qualifiedName": "last_run_started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "295": {
+ "qualifiedName": "actor_review_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "296": {
+ "qualifiedName": "actor_review_rating",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "297": {
+ "qualifiedName": "bookmark_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "298": {
+ "qualifiedName": "public_actor_run_stats30_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "299": {
+ "qualifiedName": "AddRequestResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "300": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "301": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "302": {
+ "qualifiedName": "AddedRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "303": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "304": {
+ "qualifiedName": "request_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "305": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "306": {
+ "qualifiedName": "was_already_present",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "307": {
+ "qualifiedName": "was_already_handled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "308": {
+ "qualifiedName": "BatchAddResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "309": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "310": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "311": {
+ "qualifiedName": "BatchAddResult",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "312": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "313": {
+ "qualifiedName": "processed_requests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "314": {
+ "qualifiedName": "unprocessed_requests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "315": {
+ "qualifiedName": "BatchDeleteResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "316": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "317": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "318": {
+ "qualifiedName": "BatchDeleteResult",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "319": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "320": {
+ "qualifiedName": "processed_requests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "321": {
+ "qualifiedName": "unprocessed_requests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "322": {
+ "qualifiedName": "BrowserInfoResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "323": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "324": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "325": {
+ "qualifiedName": "client_ip",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "326": {
+ "qualifiedName": "country_code",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "327": {
+ "qualifiedName": "body_length",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "328": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "329": {
+ "qualifiedName": "raw_headers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "330": {
+ "qualifiedName": "Build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "331": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "332": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "333": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "334": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "335": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "336": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "337": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "338": {
+ "qualifiedName": "meta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "339": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "340": {
+ "qualifiedName": "options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "341": {
+ "qualifiedName": "usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "342": {
+ "qualifiedName": "usage_total_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "343": {
+ "qualifiedName": "usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "344": {
+ "qualifiedName": "input_schema",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "345": {
+ "qualifiedName": "readme",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "346": {
+ "qualifiedName": "build_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "347": {
+ "qualifiedName": "act_version",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "348": {
+ "qualifiedName": "actor_definition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "349": {
+ "qualifiedName": "BuildOptions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "350": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "351": {
+ "qualifiedName": "use_cache",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "352": {
+ "qualifiedName": "beta_packages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "353": {
+ "qualifiedName": "memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "354": {
+ "qualifiedName": "disk_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "355": {
+ "qualifiedName": "BuildResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "356": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "357": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "358": {
+ "qualifiedName": "BuildShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "359": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "360": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "361": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "362": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "363": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "364": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "365": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "366": {
+ "qualifiedName": "usage_total_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "367": {
+ "qualifiedName": "build_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "368": {
+ "qualifiedName": "build_number_int",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "369": {
+ "qualifiedName": "meta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "370": {
+ "qualifiedName": "BuildStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "371": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "372": {
+ "qualifiedName": "duration_millis",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "373": {
+ "qualifiedName": "run_time_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "374": {
+ "qualifiedName": "compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "375": {
+ "qualifiedName": "image_size_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "376": {
+ "qualifiedName": "BuildTag",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "377": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "378": {
+ "qualifiedName": "build_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "379": {
+ "qualifiedName": "BuildUsage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "380": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "381": {
+ "qualifiedName": "actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "382": {
+ "qualifiedName": "BuildsMeta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "383": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "384": {
+ "qualifiedName": "origin",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "385": {
+ "qualifiedName": "client_ip",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "386": {
+ "qualifiedName": "user_agent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "387": {
+ "qualifiedName": "Call",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "388": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "389": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "390": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "391": {
+ "qualifiedName": "error_message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "392": {
+ "qualifiedName": "response_status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "393": {
+ "qualifiedName": "response_body",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "394": {
+ "qualifiedName": "ChargeRunRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "395": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "396": {
+ "qualifiedName": "event_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "397": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "398": {
+ "qualifiedName": "CommonActorPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "399": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "400": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "401": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "402": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "403": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "404": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "405": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "406": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "407": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "408": {
+ "qualifiedName": "CreateActorRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "409": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "410": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "411": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "412": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "413": {
+ "qualifiedName": "is_public",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "414": {
+ "qualifiedName": "seo_title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "415": {
+ "qualifiedName": "seo_description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "416": {
+ "qualifiedName": "restart_on_error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "417": {
+ "qualifiedName": "versions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "418": {
+ "qualifiedName": "pricing_infos",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "419": {
+ "qualifiedName": "categories",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "420": {
+ "qualifiedName": "default_run_options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "421": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "422": {
+ "qualifiedName": "example_run_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "423": {
+ "qualifiedName": "is_deprecated",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "424": {
+ "qualifiedName": "CreateOrUpdateVersionRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "425": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "426": {
+ "qualifiedName": "version_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "427": {
+ "qualifiedName": "source_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "428": {
+ "qualifiedName": "env_vars",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "429": {
+ "qualifiedName": "apply_env_vars_to_build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "430": {
+ "qualifiedName": "build_tag",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "431": {
+ "qualifiedName": "source_files",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "432": {
+ "qualifiedName": "git_repo_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "433": {
+ "qualifiedName": "tarball_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "434": {
+ "qualifiedName": "github_gist_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "435": {
+ "qualifiedName": "CreateTaskRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "436": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "437": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "438": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "439": {
+ "qualifiedName": "options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "440": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "441": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "442": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "443": {
+ "qualifiedName": "Current",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "444": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "445": {
+ "qualifiedName": "monthly_usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "446": {
+ "qualifiedName": "monthly_actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "447": {
+ "qualifiedName": "monthly_external_data_transfer_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "448": {
+ "qualifiedName": "monthly_proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "449": {
+ "qualifiedName": "monthly_residential_proxy_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "450": {
+ "qualifiedName": "actor_memory_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "451": {
+ "qualifiedName": "actor_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "452": {
+ "qualifiedName": "actor_task_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "453": {
+ "qualifiedName": "active_actor_job_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "454": {
+ "qualifiedName": "team_account_seat_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "455": {
+ "qualifiedName": "schedule_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "456": {
+ "qualifiedName": "CurrentPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "457": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "458": {
+ "qualifiedName": "pricing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "459": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "460": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "461": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "462": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "463": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "464": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "465": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "466": {
+ "qualifiedName": "is_ppe_platform_usage_paid_by_user",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "467": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "468": {
+ "qualifiedName": "trial_minutes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "469": {
+ "qualifiedName": "unit_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "470": {
+ "qualifiedName": "price_per_unit_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "471": {
+ "qualifiedName": "minimal_max_total_charge_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "472": {
+ "qualifiedName": "pricing_per_event",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "473": {
+ "qualifiedName": "DailyServiceUsages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "474": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "475": {
+ "qualifiedName": "date",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "476": {
+ "qualifiedName": "service_usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "477": {
+ "qualifiedName": "total_usage_credits_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "478": {
+ "qualifiedName": "Dataset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "479": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "480": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "481": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "482": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "483": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "484": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "485": {
+ "qualifiedName": "accessed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "486": {
+ "qualifiedName": "item_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "487": {
+ "qualifiedName": "clean_item_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "488": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "489": {
+ "qualifiedName": "act_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "490": {
+ "qualifiedName": "fields",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "491": {
+ "qualifiedName": "schema_",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "492": {
+ "qualifiedName": "console_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "493": {
+ "qualifiedName": "items_public_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "494": {
+ "qualifiedName": "url_signing_secret_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "495": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "496": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "497": {
+ "qualifiedName": "DatasetFieldStatistics",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "498": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "499": {
+ "qualifiedName": "min",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "500": {
+ "qualifiedName": "max",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "501": {
+ "qualifiedName": "null_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "502": {
+ "qualifiedName": "empty_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "503": {
+ "qualifiedName": "DatasetListItem",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "504": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "505": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "506": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "507": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "508": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "509": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "510": {
+ "qualifiedName": "accessed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "511": {
+ "qualifiedName": "item_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "512": {
+ "qualifiedName": "clean_item_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "513": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "514": {
+ "qualifiedName": "act_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "515": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "516": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "517": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "518": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "519": {
+ "qualifiedName": "DatasetResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "520": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "521": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "522": {
+ "qualifiedName": "DatasetSchemaValidationError",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "523": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "524": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "525": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "526": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "527": {
+ "qualifiedName": "DatasetStatistics",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "528": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "529": {
+ "qualifiedName": "field_statistics",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "530": {
+ "qualifiedName": "DatasetStatisticsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "531": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "532": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "533": {
+ "qualifiedName": "DatasetStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "534": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "535": {
+ "qualifiedName": "read_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "536": {
+ "qualifiedName": "write_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "537": {
+ "qualifiedName": "storage_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "538": {
+ "qualifiedName": "inflated_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "539": {
+ "qualifiedName": "Datasets",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "540": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "541": {
+ "qualifiedName": "default",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "542": {
+ "qualifiedName": "DecodeAndVerifyData",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "543": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "544": {
+ "qualifiedName": "decoded",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "545": {
+ "qualifiedName": "encoded_by_user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "546": {
+ "qualifiedName": "is_verified_user",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "547": {
+ "qualifiedName": "DecodeAndVerifyResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "548": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "549": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "550": {
+ "qualifiedName": "DefaultRunOptions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "551": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "552": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "553": {
+ "qualifiedName": "timeout_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "554": {
+ "qualifiedName": "memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "555": {
+ "qualifiedName": "restart_on_error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "556": {
+ "qualifiedName": "max_items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "557": {
+ "qualifiedName": "force_permission_level",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "558": {
+ "qualifiedName": "DeletedRequestById",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "559": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "560": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "561": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "562": {
+ "qualifiedName": "DeletedRequestByUniqueKey",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "563": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "564": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "565": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "566": {
+ "qualifiedName": "EffectivePlatformFeature",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "567": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "568": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "569": {
+ "qualifiedName": "disabled_reason",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "570": {
+ "qualifiedName": "disabled_reason_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "571": {
+ "qualifiedName": "is_trial",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "572": {
+ "qualifiedName": "trial_expiration_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "573": {
+ "qualifiedName": "EffectivePlatformFeatures",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "574": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "575": {
+ "qualifiedName": "actors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "576": {
+ "qualifiedName": "storage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "577": {
+ "qualifiedName": "scheduler",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "578": {
+ "qualifiedName": "proxy",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "579": {
+ "qualifiedName": "proxy_external_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "580": {
+ "qualifiedName": "proxy_residential",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "581": {
+ "qualifiedName": "proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "582": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "583": {
+ "qualifiedName": "actors_public_all",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "584": {
+ "qualifiedName": "actors_public_developer",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "585": {
+ "qualifiedName": "EncodeAndSignData",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "586": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "587": {
+ "qualifiedName": "encoded",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "588": {
+ "qualifiedName": "DecodeAndVerifyRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "589": {
+ "qualifiedName": "EncodeAndSignResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "590": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "591": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "592": {
+ "qualifiedName": "EnvVar",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "593": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "594": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "595": {
+ "qualifiedName": "value",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "596": {
+ "qualifiedName": "is_secret",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "597": {
+ "qualifiedName": "EnvVarRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "598": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "599": {
+ "qualifiedName": "EnvVarResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "600": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "601": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "602": {
+ "qualifiedName": "ErrorDetail",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "603": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "604": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "605": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "606": {
+ "qualifiedName": "ErrorResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "607": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "608": {
+ "qualifiedName": "error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "609": {
+ "qualifiedName": "EventData",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "610": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "611": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "612": {
+ "qualifiedName": "actor_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "613": {
+ "qualifiedName": "ExampleRunInput",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "614": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "615": {
+ "qualifiedName": "body",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "616": {
+ "qualifiedName": "content_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "617": {
+ "qualifiedName": "ExampleWebhookDispatch",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "618": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "619": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "620": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "621": {
+ "qualifiedName": "removed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "622": {
+ "qualifiedName": "FlatPricePerMonthActorPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "623": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "624": {
+ "qualifiedName": "pricing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "625": {
+ "qualifiedName": "trial_minutes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "626": {
+ "qualifiedName": "price_per_unit_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "627": {
+ "qualifiedName": "FreeActorPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "628": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "629": {
+ "qualifiedName": "pricing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "630": {
+ "qualifiedName": "HeadAndLockResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "631": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "632": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "633": {
+ "qualifiedName": "HeadRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "634": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "635": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "636": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "637": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "638": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "639": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "640": {
+ "qualifiedName": "HeadResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "641": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "642": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "643": {
+ "qualifiedName": "InvalidItem",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "644": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "645": {
+ "qualifiedName": "item_position",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "646": {
+ "qualifiedName": "validation_errors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "647": {
+ "qualifiedName": "KeyValueStore",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "648": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "649": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "650": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "651": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "652": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "653": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "654": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "655": {
+ "qualifiedName": "accessed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "656": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "657": {
+ "qualifiedName": "act_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "658": {
+ "qualifiedName": "console_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "659": {
+ "qualifiedName": "keys_public_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "660": {
+ "qualifiedName": "records_public_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "661": {
+ "qualifiedName": "schema_",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "662": {
+ "qualifiedName": "url_signing_secret_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "663": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "664": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "665": {
+ "qualifiedName": "KeyValueStoreKey",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "666": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "667": {
+ "qualifiedName": "key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "668": {
+ "qualifiedName": "size",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "669": {
+ "qualifiedName": "record_public_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "670": {
+ "qualifiedName": "KeyValueStoreResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "671": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "672": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "673": {
+ "qualifiedName": "KeyValueStoreStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "674": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "675": {
+ "qualifiedName": "read_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "676": {
+ "qualifiedName": "write_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "677": {
+ "qualifiedName": "delete_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "678": {
+ "qualifiedName": "list_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "679": {
+ "qualifiedName": "s3_storage_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "680": {
+ "qualifiedName": "storage_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "681": {
+ "qualifiedName": "KeyValueStores",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "682": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "683": {
+ "qualifiedName": "default",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "684": {
+ "qualifiedName": "Limits",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "685": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "686": {
+ "qualifiedName": "max_monthly_usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "687": {
+ "qualifiedName": "max_monthly_actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "688": {
+ "qualifiedName": "max_monthly_external_data_transfer_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "689": {
+ "qualifiedName": "max_monthly_proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "690": {
+ "qualifiedName": "max_monthly_residential_proxy_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "691": {
+ "qualifiedName": "max_actor_memory_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "692": {
+ "qualifiedName": "max_actor_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "693": {
+ "qualifiedName": "max_actor_task_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "694": {
+ "qualifiedName": "max_concurrent_actor_jobs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "695": {
+ "qualifiedName": "max_team_account_seat_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "696": {
+ "qualifiedName": "data_retention_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "697": {
+ "qualifiedName": "max_schedule_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "698": {
+ "qualifiedName": "LimitsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "699": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "700": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "701": {
+ "qualifiedName": "ListOfActorsInStoreResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "702": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "703": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "704": {
+ "qualifiedName": "ListOfActorsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "705": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "706": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "707": {
+ "qualifiedName": "ListOfBuildsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "708": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "709": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "710": {
+ "qualifiedName": "ListOfDatasetsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "711": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "712": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "713": {
+ "qualifiedName": "ListOfEnvVars",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "714": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "715": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "716": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "717": {
+ "qualifiedName": "ListOfEnvVarsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "718": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "719": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "720": {
+ "qualifiedName": "ListOfKeyValueStoresResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "721": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "722": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "723": {
+ "qualifiedName": "ListOfKeys",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "724": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "725": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "726": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "727": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "728": {
+ "qualifiedName": "exclusive_start_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "729": {
+ "qualifiedName": "is_truncated",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "730": {
+ "qualifiedName": "next_exclusive_start_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "731": {
+ "qualifiedName": "ListOfKeysResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "732": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "733": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "734": {
+ "qualifiedName": "ListOfRequestQueuesResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "735": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "736": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "737": {
+ "qualifiedName": "ListOfRequests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "738": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "739": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "740": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "741": {
+ "qualifiedName": "exclusive_start_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "742": {
+ "qualifiedName": "cursor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "743": {
+ "qualifiedName": "next_cursor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "744": {
+ "qualifiedName": "ListOfRequestsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "745": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "746": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "747": {
+ "qualifiedName": "ListOfRunsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "748": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "749": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "750": {
+ "qualifiedName": "ListOfSchedulesResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "751": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "752": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "753": {
+ "qualifiedName": "ListOfTasksResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "754": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "755": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "756": {
+ "qualifiedName": "ListOfVersions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "757": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "758": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "759": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "760": {
+ "qualifiedName": "ListOfVersionsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "761": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "762": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "763": {
+ "qualifiedName": "ListOfWebhookDispatchesResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "764": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "765": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "766": {
+ "qualifiedName": "ListOfWebhooksResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "767": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "768": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "769": {
+ "qualifiedName": "LockedHeadRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "770": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "771": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "772": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "773": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "774": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "775": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "776": {
+ "qualifiedName": "lock_expires_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "777": {
+ "qualifiedName": "LockedRequestQueueHead",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "778": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "779": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "780": {
+ "qualifiedName": "queue_modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "781": {
+ "qualifiedName": "queue_has_locked_requests",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "782": {
+ "qualifiedName": "client_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "783": {
+ "qualifiedName": "had_multiple_clients",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "784": {
+ "qualifiedName": "lock_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "785": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "786": {
+ "qualifiedName": "Metamorph",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "787": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "788": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "789": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "790": {
+ "qualifiedName": "build_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "791": {
+ "qualifiedName": "input_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "792": {
+ "qualifiedName": "MonthlyUsage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "793": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "794": {
+ "qualifiedName": "usage_cycle",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "795": {
+ "qualifiedName": "monthly_service_usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "796": {
+ "qualifiedName": "daily_service_usages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "797": {
+ "qualifiedName": "total_usage_credits_usd_before_volume_discount",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "798": {
+ "qualifiedName": "total_usage_credits_usd_after_volume_discount",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "799": {
+ "qualifiedName": "MonthlyUsageResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "800": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "801": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "802": {
+ "qualifiedName": "Notifications",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "803": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "804": {
+ "qualifiedName": "email",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "805": {
+ "qualifiedName": "PaginationResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "806": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "807": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "808": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "809": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "810": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "811": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "812": {
+ "qualifiedName": "ListOfActors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "813": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "814": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "815": {
+ "qualifiedName": "ListOfBuilds",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "816": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "817": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "818": {
+ "qualifiedName": "ListOfDatasets",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "819": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "820": {
+ "qualifiedName": "unnamed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "821": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "822": {
+ "qualifiedName": "ListOfKeyValueStores",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "823": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "824": {
+ "qualifiedName": "unnamed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "825": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "826": {
+ "qualifiedName": "ListOfRequestQueues",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "827": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "828": {
+ "qualifiedName": "unnamed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "829": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "830": {
+ "qualifiedName": "ListOfRuns",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "831": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "832": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "833": {
+ "qualifiedName": "ListOfSchedules",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "834": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "835": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "836": {
+ "qualifiedName": "ListOfStoreActors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "837": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "838": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "839": {
+ "qualifiedName": "ListOfTasks",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "840": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "841": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "842": {
+ "qualifiedName": "ListOfWebhookDispatches",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "843": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "844": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "845": {
+ "qualifiedName": "ListOfWebhooks",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "846": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "847": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "848": {
+ "qualifiedName": "PayPerEventActorPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "849": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "850": {
+ "qualifiedName": "pricing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "851": {
+ "qualifiedName": "pricing_per_event",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "852": {
+ "qualifiedName": "minimal_max_total_charge_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "853": {
+ "qualifiedName": "Plan",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "854": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "855": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "856": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "857": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "858": {
+ "qualifiedName": "monthly_base_price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "859": {
+ "qualifiedName": "monthly_usage_credits_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "860": {
+ "qualifiedName": "usage_discount_percent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "861": {
+ "qualifiedName": "enabled_platform_features",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "862": {
+ "qualifiedName": "max_monthly_usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "863": {
+ "qualifiedName": "max_actor_memory_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "864": {
+ "qualifiedName": "max_monthly_actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "865": {
+ "qualifiedName": "max_monthly_residential_proxy_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "866": {
+ "qualifiedName": "max_monthly_proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "867": {
+ "qualifiedName": "max_monthly_external_data_transfer_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "868": {
+ "qualifiedName": "max_actor_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "869": {
+ "qualifiedName": "max_actor_task_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "870": {
+ "qualifiedName": "data_retention_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "871": {
+ "qualifiedName": "available_proxy_groups",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "872": {
+ "qualifiedName": "team_account_seat_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "873": {
+ "qualifiedName": "support_level",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "874": {
+ "qualifiedName": "available_add_ons",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "875": {
+ "qualifiedName": "tier",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "876": {
+ "qualifiedName": "api_rate_limit_boosts",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "877": {
+ "qualifiedName": "max_schedule_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "878": {
+ "qualifiedName": "max_concurrent_actor_runs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "879": {
+ "qualifiedName": "plan_pricing",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "880": {
+ "qualifiedName": "PricePerDatasetItemActorPricingInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "881": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "882": {
+ "qualifiedName": "pricing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "883": {
+ "qualifiedName": "unit_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "884": {
+ "qualifiedName": "price_per_unit_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "885": {
+ "qualifiedName": "tiered_pricing",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "886": {
+ "qualifiedName": "PriceTiers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "887": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "888": {
+ "qualifiedName": "quantity_above",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "889": {
+ "qualifiedName": "discount_percent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "890": {
+ "qualifiedName": "tier_quantity",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "891": {
+ "qualifiedName": "unit_price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "892": {
+ "qualifiedName": "price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "893": {
+ "qualifiedName": "PricingPerEvent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "894": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "895": {
+ "qualifiedName": "actor_charge_events",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "896": {
+ "qualifiedName": "PrivateUserDataResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "897": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "898": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "899": {
+ "qualifiedName": "Profile",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "900": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "901": {
+ "qualifiedName": "bio",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "902": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "903": {
+ "qualifiedName": "picture_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "904": {
+ "qualifiedName": "github_username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "905": {
+ "qualifiedName": "website_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "906": {
+ "qualifiedName": "twitter_username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "907": {
+ "qualifiedName": "ProlongRequestLockResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "908": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "909": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "910": {
+ "qualifiedName": "Proxy",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "911": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "912": {
+ "qualifiedName": "password",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "913": {
+ "qualifiedName": "groups",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "914": {
+ "qualifiedName": "ProxyGroup",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "915": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "916": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "917": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "918": {
+ "qualifiedName": "available_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "919": {
+ "qualifiedName": "PublicActorRunStats30Days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "920": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "921": {
+ "qualifiedName": "aborted",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "922": {
+ "qualifiedName": "failed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "923": {
+ "qualifiedName": "succeeded",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "924": {
+ "qualifiedName": "timed_out",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "925": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "926": {
+ "qualifiedName": "PublicUserDataResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "927": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "928": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "929": {
+ "qualifiedName": "PutItemResponseError",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "930": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "931": {
+ "qualifiedName": "error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "932": {
+ "qualifiedName": "PutItemsRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "933": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "934": {
+ "qualifiedName": "PutRecordRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "935": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "936": {
+ "qualifiedName": "RecordResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "937": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "938": {
+ "qualifiedName": "RequestBase",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "939": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "940": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "941": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "942": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "943": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "944": {
+ "qualifiedName": "loaded_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "945": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "946": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "947": {
+ "qualifiedName": "user_data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "948": {
+ "qualifiedName": "no_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "949": {
+ "qualifiedName": "error_messages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "950": {
+ "qualifiedName": "handled_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "951": {
+ "qualifiedName": "Request",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "952": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "953": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "954": {
+ "qualifiedName": "RequestDraft",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "955": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "956": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "957": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "958": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "959": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "960": {
+ "qualifiedName": "RequestDraftDeleteById",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "961": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "962": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "963": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "964": {
+ "qualifiedName": "RequestDraftDeleteByUniqueKey",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "965": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "966": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "967": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "968": {
+ "qualifiedName": "RequestDraftDelete",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "969": {
+ "qualifiedName": "root",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "970": {
+ "qualifiedName": "RequestLockInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "971": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "972": {
+ "qualifiedName": "lock_expires_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "973": {
+ "qualifiedName": "RequestQueue",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "974": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "975": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "976": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "977": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "978": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "979": {
+ "qualifiedName": "act_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "980": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "981": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "982": {
+ "qualifiedName": "accessed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "983": {
+ "qualifiedName": "total_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "984": {
+ "qualifiedName": "handled_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "985": {
+ "qualifiedName": "pending_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "986": {
+ "qualifiedName": "had_multiple_clients",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "987": {
+ "qualifiedName": "console_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "988": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "989": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "990": {
+ "qualifiedName": "RequestQueueHead",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "991": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "992": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "993": {
+ "qualifiedName": "queue_modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "994": {
+ "qualifiedName": "had_multiple_clients",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "995": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "996": {
+ "qualifiedName": "RequestQueueResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "997": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "998": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "999": {
+ "qualifiedName": "RequestQueueShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1000": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1001": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1002": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1003": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1004": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1005": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1006": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1007": {
+ "qualifiedName": "accessed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1008": {
+ "qualifiedName": "expire_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1009": {
+ "qualifiedName": "total_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1010": {
+ "qualifiedName": "handled_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1011": {
+ "qualifiedName": "pending_request_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1012": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1013": {
+ "qualifiedName": "act_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1014": {
+ "qualifiedName": "had_multiple_clients",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1015": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1016": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1017": {
+ "qualifiedName": "RequestQueueStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1018": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1019": {
+ "qualifiedName": "delete_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1020": {
+ "qualifiedName": "head_item_read_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1021": {
+ "qualifiedName": "read_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1022": {
+ "qualifiedName": "storage_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1023": {
+ "qualifiedName": "write_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1024": {
+ "qualifiedName": "RequestQueues",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1025": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1026": {
+ "qualifiedName": "default",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1027": {
+ "qualifiedName": "RequestRegistration",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1028": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1029": {
+ "qualifiedName": "request_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1030": {
+ "qualifiedName": "was_already_present",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1031": {
+ "qualifiedName": "was_already_handled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1032": {
+ "qualifiedName": "RequestResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1033": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1034": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1035": {
+ "qualifiedName": "RequestUserData",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1036": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1037": {
+ "qualifiedName": "Run",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1038": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1039": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1040": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1041": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1042": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1043": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1044": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1045": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1046": {
+ "qualifiedName": "status_message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1047": {
+ "qualifiedName": "is_status_message_terminal",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1048": {
+ "qualifiedName": "meta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1049": {
+ "qualifiedName": "pricing_info",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1050": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1051": {
+ "qualifiedName": "charged_event_counts",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1052": {
+ "qualifiedName": "options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1053": {
+ "qualifiedName": "build_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1054": {
+ "qualifiedName": "exit_code",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1055": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1056": {
+ "qualifiedName": "default_key_value_store_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1057": {
+ "qualifiedName": "default_dataset_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1058": {
+ "qualifiedName": "default_request_queue_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1059": {
+ "qualifiedName": "storage_ids",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1060": {
+ "qualifiedName": "build_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1061": {
+ "qualifiedName": "container_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1062": {
+ "qualifiedName": "is_container_server_ready",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1063": {
+ "qualifiedName": "git_branch_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1064": {
+ "qualifiedName": "usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1065": {
+ "qualifiedName": "usage_total_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1066": {
+ "qualifiedName": "usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1067": {
+ "qualifiedName": "metamorphs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1068": {
+ "qualifiedName": "platform_usage_billing_model",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1069": {
+ "qualifiedName": "RunFailedErrorDetail",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1070": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1071": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1072": {
+ "qualifiedName": "RunMeta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1073": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1074": {
+ "qualifiedName": "origin",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1075": {
+ "qualifiedName": "client_ip",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1076": {
+ "qualifiedName": "user_agent",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1077": {
+ "qualifiedName": "schedule_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1078": {
+ "qualifiedName": "scheduled_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1079": {
+ "qualifiedName": "RunOptions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1080": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1081": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1082": {
+ "qualifiedName": "timeout_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1083": {
+ "qualifiedName": "memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1084": {
+ "qualifiedName": "disk_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1085": {
+ "qualifiedName": "max_items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1086": {
+ "qualifiedName": "max_total_charge_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1087": {
+ "qualifiedName": "RunResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1088": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1089": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1090": {
+ "qualifiedName": "RunShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1091": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1092": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1093": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1094": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1095": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1096": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1097": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1098": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1099": {
+ "qualifiedName": "build_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1100": {
+ "qualifiedName": "build_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1101": {
+ "qualifiedName": "build_number_int",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1102": {
+ "qualifiedName": "meta",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1103": {
+ "qualifiedName": "usage_total_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1104": {
+ "qualifiedName": "default_key_value_store_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1105": {
+ "qualifiedName": "default_dataset_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1106": {
+ "qualifiedName": "default_request_queue_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1107": {
+ "qualifiedName": "RunStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1108": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1109": {
+ "qualifiedName": "input_body_len",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1110": {
+ "qualifiedName": "migration_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1111": {
+ "qualifiedName": "reboot_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1112": {
+ "qualifiedName": "restart_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1113": {
+ "qualifiedName": "resurrect_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1114": {
+ "qualifiedName": "mem_avg_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1115": {
+ "qualifiedName": "mem_max_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1116": {
+ "qualifiedName": "mem_current_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1117": {
+ "qualifiedName": "cpu_avg_usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1118": {
+ "qualifiedName": "cpu_max_usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1119": {
+ "qualifiedName": "cpu_current_usage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1120": {
+ "qualifiedName": "net_rx_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1121": {
+ "qualifiedName": "net_tx_bytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1122": {
+ "qualifiedName": "duration_millis",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1123": {
+ "qualifiedName": "run_time_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1124": {
+ "qualifiedName": "metamorph",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1125": {
+ "qualifiedName": "compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1126": {
+ "qualifiedName": "RunTimeoutExceededErrorDetail",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1127": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1128": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1129": {
+ "qualifiedName": "RunUsage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1130": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1131": {
+ "qualifiedName": "actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1132": {
+ "qualifiedName": "dataset_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1133": {
+ "qualifiedName": "dataset_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1134": {
+ "qualifiedName": "key_value_store_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1135": {
+ "qualifiedName": "key_value_store_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1136": {
+ "qualifiedName": "key_value_store_lists",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1137": {
+ "qualifiedName": "request_queue_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1138": {
+ "qualifiedName": "request_queue_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1139": {
+ "qualifiedName": "data_transfer_internal_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1140": {
+ "qualifiedName": "data_transfer_external_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1141": {
+ "qualifiedName": "proxy_residential_transfer_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1142": {
+ "qualifiedName": "proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1143": {
+ "qualifiedName": "RunUsageUsd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1144": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1145": {
+ "qualifiedName": "actor_compute_units",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1146": {
+ "qualifiedName": "dataset_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1147": {
+ "qualifiedName": "dataset_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1148": {
+ "qualifiedName": "key_value_store_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1149": {
+ "qualifiedName": "key_value_store_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1150": {
+ "qualifiedName": "key_value_store_lists",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1151": {
+ "qualifiedName": "request_queue_reads",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1152": {
+ "qualifiedName": "request_queue_writes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1153": {
+ "qualifiedName": "data_transfer_internal_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1154": {
+ "qualifiedName": "data_transfer_external_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1155": {
+ "qualifiedName": "proxy_residential_transfer_gbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1156": {
+ "qualifiedName": "proxy_serps",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1157": {
+ "qualifiedName": "ScheduleActionRunActor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1158": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1159": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1160": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1161": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1162": {
+ "qualifiedName": "run_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1163": {
+ "qualifiedName": "run_options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1164": {
+ "qualifiedName": "ScheduleActionRunActorTask",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1165": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1166": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1167": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1168": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1169": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1170": {
+ "qualifiedName": "ScheduleActionRunInput",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1171": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1172": {
+ "qualifiedName": "body",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1173": {
+ "qualifiedName": "content_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1174": {
+ "qualifiedName": "ScheduleActionShortRunActor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1175": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1176": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1177": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1178": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1179": {
+ "qualifiedName": "ScheduleActionShortRunActorTask",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1180": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1181": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1182": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1183": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1184": {
+ "qualifiedName": "ScheduleBase",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1185": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1186": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1187": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1188": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1189": {
+ "qualifiedName": "cron_expression",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1190": {
+ "qualifiedName": "timezone",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1191": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1192": {
+ "qualifiedName": "is_exclusive",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1193": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1194": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1195": {
+ "qualifiedName": "next_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1196": {
+ "qualifiedName": "last_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1197": {
+ "qualifiedName": "Schedule",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1198": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1199": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1200": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1201": {
+ "qualifiedName": "notifications",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1202": {
+ "qualifiedName": "actions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1203": {
+ "qualifiedName": "ScheduleCreate",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1204": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1205": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1206": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1207": {
+ "qualifiedName": "is_exclusive",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1208": {
+ "qualifiedName": "cron_expression",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1209": {
+ "qualifiedName": "timezone",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1210": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1211": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1212": {
+ "qualifiedName": "actions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1213": {
+ "qualifiedName": "ScheduleCreateActionRunActor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1214": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1215": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1216": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1217": {
+ "qualifiedName": "run_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1218": {
+ "qualifiedName": "run_options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1219": {
+ "qualifiedName": "ScheduleCreateActionRunActorTask",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1220": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1221": {
+ "qualifiedName": "type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1222": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1223": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1224": {
+ "qualifiedName": "ScheduleInvoked",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1225": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1226": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1227": {
+ "qualifiedName": "level",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1228": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1229": {
+ "qualifiedName": "ScheduleLogResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1230": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1231": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1232": {
+ "qualifiedName": "ScheduleResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1233": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1234": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1235": {
+ "qualifiedName": "ScheduleShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1236": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1237": {
+ "qualifiedName": "actions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1238": {
+ "qualifiedName": "SchemaValidationErrorData",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1239": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1240": {
+ "qualifiedName": "invalid_items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1241": {
+ "qualifiedName": "SourceCodeFile",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1242": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1243": {
+ "qualifiedName": "format",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1244": {
+ "qualifiedName": "content",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1245": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1246": {
+ "qualifiedName": "SourceCodeFolder",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1247": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1248": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1249": {
+ "qualifiedName": "folder",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1250": {
+ "qualifiedName": "StorageIds",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1251": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1252": {
+ "qualifiedName": "datasets",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1253": {
+ "qualifiedName": "key_value_stores",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1254": {
+ "qualifiedName": "request_queues",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1255": {
+ "qualifiedName": "Storages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1256": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1257": {
+ "qualifiedName": "dataset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1258": {
+ "qualifiedName": "StoreListActor",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1259": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1260": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1261": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1262": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1263": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1264": {
+ "qualifiedName": "user_full_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1265": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1266": {
+ "qualifiedName": "categories",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1267": {
+ "qualifiedName": "notice",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1268": {
+ "qualifiedName": "picture_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1269": {
+ "qualifiedName": "user_picture_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1270": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1271": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1272": {
+ "qualifiedName": "current_pricing_info",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1273": {
+ "qualifiedName": "is_white_listed_for_agentic_payments",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1274": {
+ "qualifiedName": "actor_review_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1275": {
+ "qualifiedName": "actor_review_rating",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1276": {
+ "qualifiedName": "bookmark_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1277": {
+ "qualifiedName": "badge",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1278": {
+ "qualifiedName": "readme_summary",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1279": {
+ "qualifiedName": "TaggedBuildInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1280": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1281": {
+ "qualifiedName": "build_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1282": {
+ "qualifiedName": "build_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1283": {
+ "qualifiedName": "build_number_int",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1284": {
+ "qualifiedName": "finished_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1285": {
+ "qualifiedName": "Task",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1286": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1287": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1288": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1289": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1290": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1291": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1292": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1293": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1294": {
+ "qualifiedName": "removed_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1295": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1296": {
+ "qualifiedName": "options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1297": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1298": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1299": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1300": {
+ "qualifiedName": "standby_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1301": {
+ "qualifiedName": "TaskInput",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1302": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1303": {
+ "qualifiedName": "TaskOptions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1304": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1305": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1306": {
+ "qualifiedName": "timeout_secs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1307": {
+ "qualifiedName": "memory_mbytes",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1308": {
+ "qualifiedName": "max_items",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1309": {
+ "qualifiedName": "max_total_charge_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1310": {
+ "qualifiedName": "restart_on_error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1311": {
+ "qualifiedName": "TaskResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1312": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1313": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1314": {
+ "qualifiedName": "TaskShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1315": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1316": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1317": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1318": {
+ "qualifiedName": "act_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1319": {
+ "qualifiedName": "act_name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1320": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1321": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1322": {
+ "qualifiedName": "act_username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1323": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1324": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1325": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1326": {
+ "qualifiedName": "TaskStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1327": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1328": {
+ "qualifiedName": "total_runs",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1329": {
+ "qualifiedName": "TestWebhookResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1330": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1331": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1332": {
+ "qualifiedName": "TieredPricingPerDatasetItemEntry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1333": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1334": {
+ "qualifiedName": "tiered_price_per_unit_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1335": {
+ "qualifiedName": "TieredPricingPerEventEntry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1336": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1337": {
+ "qualifiedName": "tiered_event_price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1338": {
+ "qualifiedName": "UnlockRequestsResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1339": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1340": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1341": {
+ "qualifiedName": "UnlockRequestsResult",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1342": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1343": {
+ "qualifiedName": "unlocked_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1344": {
+ "qualifiedName": "UpdateActorRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1345": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1346": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1347": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1348": {
+ "qualifiedName": "is_public",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1349": {
+ "qualifiedName": "actor_permission_level",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1350": {
+ "qualifiedName": "seo_title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1351": {
+ "qualifiedName": "seo_description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1352": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1353": {
+ "qualifiedName": "restart_on_error",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1354": {
+ "qualifiedName": "versions",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1355": {
+ "qualifiedName": "pricing_infos",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1356": {
+ "qualifiedName": "categories",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1357": {
+ "qualifiedName": "default_run_options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1358": {
+ "qualifiedName": "tagged_builds",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1359": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1360": {
+ "qualifiedName": "example_run_input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1361": {
+ "qualifiedName": "is_deprecated",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1362": {
+ "qualifiedName": "UpdateDatasetRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1363": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1364": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1365": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1366": {
+ "qualifiedName": "UpdateLimitsRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1367": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1368": {
+ "qualifiedName": "max_monthly_usage_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1369": {
+ "qualifiedName": "data_retention_days",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1370": {
+ "qualifiedName": "UpdateRequestQueueRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1371": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1372": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1373": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1374": {
+ "qualifiedName": "UpdateRequestResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1375": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1376": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1377": {
+ "qualifiedName": "UpdateRunRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1378": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1379": {
+ "qualifiedName": "run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1380": {
+ "qualifiedName": "status_message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1381": {
+ "qualifiedName": "is_status_message_terminal",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1382": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1383": {
+ "qualifiedName": "UpdateStoreRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1384": {
+ "qualifiedName": "UpdateTaskRequest",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1385": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1386": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1387": {
+ "qualifiedName": "options",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1388": {
+ "qualifiedName": "input",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1389": {
+ "qualifiedName": "title",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1390": {
+ "qualifiedName": "actor_standby",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1391": {
+ "qualifiedName": "UsageCycle",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1392": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1393": {
+ "qualifiedName": "start_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1394": {
+ "qualifiedName": "end_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1395": {
+ "qualifiedName": "UsageItem",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1396": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1397": {
+ "qualifiedName": "quantity",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1398": {
+ "qualifiedName": "base_amount_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1399": {
+ "qualifiedName": "base_unit_price_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1400": {
+ "qualifiedName": "amount_after_volume_discount_usd",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1401": {
+ "qualifiedName": "price_tiers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1402": {
+ "qualifiedName": "UserPrivateInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1403": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1404": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1405": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1406": {
+ "qualifiedName": "profile",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1407": {
+ "qualifiedName": "email",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1408": {
+ "qualifiedName": "proxy",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1409": {
+ "qualifiedName": "plan",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1410": {
+ "qualifiedName": "effective_platform_features",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1411": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1412": {
+ "qualifiedName": "is_paying",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1413": {
+ "qualifiedName": "UserPublicInfo",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1414": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1415": {
+ "qualifiedName": "username",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1416": {
+ "qualifiedName": "profile",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1417": {
+ "qualifiedName": "ValidationError",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1418": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1419": {
+ "qualifiedName": "instance_path",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1420": {
+ "qualifiedName": "schema_path",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1421": {
+ "qualifiedName": "keyword",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1422": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1423": {
+ "qualifiedName": "params",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1424": {
+ "qualifiedName": "Version",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1425": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1426": {
+ "qualifiedName": "version_number",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1427": {
+ "qualifiedName": "source_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1428": {
+ "qualifiedName": "env_vars",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1429": {
+ "qualifiedName": "apply_env_vars_to_build",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1430": {
+ "qualifiedName": "build_tag",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1431": {
+ "qualifiedName": "source_files",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1432": {
+ "qualifiedName": "git_repo_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1433": {
+ "qualifiedName": "tarball_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1434": {
+ "qualifiedName": "github_gist_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1435": {
+ "qualifiedName": "VersionResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1436": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1437": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1438": {
+ "qualifiedName": "Webhook",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1439": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1440": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1441": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1442": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1443": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1444": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1445": {
+ "qualifiedName": "should_interpolate_strings",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1446": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1447": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1448": {
+ "qualifiedName": "ignore_ssl_errors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1449": {
+ "qualifiedName": "do_not_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1450": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1451": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1452": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1453": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1454": {
+ "qualifiedName": "last_dispatch",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1455": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1456": {
+ "qualifiedName": "WebhookCondition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1457": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1458": {
+ "qualifiedName": "actor_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1459": {
+ "qualifiedName": "actor_task_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1460": {
+ "qualifiedName": "actor_run_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1461": {
+ "qualifiedName": "WebhookCreate",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1462": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1463": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1464": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1465": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1466": {
+ "qualifiedName": "idempotency_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1467": {
+ "qualifiedName": "ignore_ssl_errors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1468": {
+ "qualifiedName": "do_not_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1469": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1470": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1471": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1472": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1473": {
+ "qualifiedName": "should_interpolate_strings",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1474": {
+ "qualifiedName": "WebhookDispatch",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1475": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1476": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1477": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1478": {
+ "qualifiedName": "webhook_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1479": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1480": {
+ "qualifiedName": "status",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1481": {
+ "qualifiedName": "event_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1482": {
+ "qualifiedName": "event_data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1483": {
+ "qualifiedName": "webhook",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1484": {
+ "qualifiedName": "calls",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1485": {
+ "qualifiedName": "WebhookDispatchResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1486": {
+ "qualifiedName": "WebhookDispatchWebhookSummary",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1487": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1488": {
+ "qualifiedName": "action_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1489": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1490": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1491": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1492": {
+ "qualifiedName": "WebhookRepresentation",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1493": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1494": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1495": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1496": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1497": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1498": {
+ "qualifiedName": "WebhookResponse",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1499": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1500": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1501": {
+ "qualifiedName": "WebhookShort",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1502": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1503": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1504": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1505": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1506": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1507": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1508": {
+ "qualifiedName": "is_apify_integration",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1509": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1510": {
+ "qualifiedName": "action_type",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1511": {
+ "qualifiedName": "should_interpolate_strings",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1512": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1513": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1514": {
+ "qualifiedName": "ignore_ssl_errors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1515": {
+ "qualifiedName": "do_not_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1516": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1517": {
+ "qualifiedName": "last_dispatch",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1518": {
+ "qualifiedName": "stats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1519": {
+ "qualifiedName": "WebhookStats",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1520": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1521": {
+ "qualifiedName": "total_dispatches",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1522": {
+ "qualifiedName": "WebhookUpdate",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1523": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1524": {
+ "qualifiedName": "is_ad_hoc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1525": {
+ "qualifiedName": "event_types",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1526": {
+ "qualifiedName": "condition",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1527": {
+ "qualifiedName": "ignore_ssl_errors",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1528": {
+ "qualifiedName": "do_not_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1529": {
+ "qualifiedName": "request_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1530": {
+ "qualifiedName": "payload_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1531": {
+ "qualifiedName": "headers_template",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1532": {
+ "qualifiedName": "description",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1533": {
+ "qualifiedName": "should_interpolate_strings",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "1534": {
+ "qualifiedName": "ApifyClient",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1535": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1547": {
+ "qualifiedName": "with_custom_http_client",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1553": {
+ "qualifiedName": "token",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1554": {
+ "qualifiedName": "http_client",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1555": {
+ "qualifiedName": "actor",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1558": {
+ "qualifiedName": "actors",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1560": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1563": {
+ "qualifiedName": "builds",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1565": {
+ "qualifiedName": "run",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1568": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1570": {
+ "qualifiedName": "dataset",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1573": {
+ "qualifiedName": "datasets",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1575": {
+ "qualifiedName": "key_value_store",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1578": {
+ "qualifiedName": "key_value_stores",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1580": {
+ "qualifiedName": "request_queue",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1584": {
+ "qualifiedName": "request_queues",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1586": {
+ "qualifiedName": "webhook",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1589": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1591": {
+ "qualifiedName": "webhook_dispatch",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1594": {
+ "qualifiedName": "webhook_dispatches",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1596": {
+ "qualifiedName": "schedule",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1599": {
+ "qualifiedName": "schedules",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1601": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1604": {
+ "qualifiedName": "task",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1607": {
+ "qualifiedName": "tasks",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1609": {
+ "qualifiedName": "user",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1612": {
+ "qualifiedName": "store",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1614": {
+ "qualifiedName": "ApifyClientAsync",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1615": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1627": {
+ "qualifiedName": "with_custom_http_client",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1633": {
+ "qualifiedName": "token",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1634": {
+ "qualifiedName": "http_client",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1635": {
+ "qualifiedName": "actor",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1638": {
+ "qualifiedName": "actors",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1640": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1643": {
+ "qualifiedName": "builds",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1645": {
+ "qualifiedName": "run",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1648": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1650": {
+ "qualifiedName": "dataset",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1653": {
+ "qualifiedName": "datasets",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1655": {
+ "qualifiedName": "key_value_store",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1658": {
+ "qualifiedName": "key_value_stores",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1660": {
+ "qualifiedName": "request_queue",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1664": {
+ "qualifiedName": "request_queues",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1666": {
+ "qualifiedName": "webhook",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1669": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1671": {
+ "qualifiedName": "webhook_dispatch",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1674": {
+ "qualifiedName": "webhook_dispatches",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1676": {
+ "qualifiedName": "schedule",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1679": {
+ "qualifiedName": "schedules",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1681": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1684": {
+ "qualifiedName": "task",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1687": {
+ "qualifiedName": "tasks",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1689": {
+ "qualifiedName": "user",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1692": {
+ "qualifiedName": "store",
+ "sourceFileName": "/src/apify_client/_apify_client.py"
+ },
+ "1694": {
+ "qualifiedName": "__version__",
+ "sourceFileName": "/src/apify_client/__init__.py"
+ },
+ "1695": {
+ "qualifiedName": "logger_name",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1696": {
+ "qualifiedName": "logger",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1697": {
+ "qualifiedName": "LogContext",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1698": {
+ "qualifiedName": "attempt",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1699": {
+ "qualifiedName": "client_method",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1700": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1701": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1702": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1703": {
+ "qualifiedName": "log_context",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1704": {
+ "qualifiedName": "WithLogDetailsClient",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1705": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1710": {
+ "qualifiedName": "RedirectLogFormatter",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1711": {
+ "qualifiedName": "format",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1714": {
+ "qualifiedName": "create_redirect_logger",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1717": {
+ "qualifiedName": "_ContextInjectingFilter",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1718": {
+ "qualifiedName": "filter",
+ "sourceFileName": "/src/apify_client/_logging.py"
+ },
+ "1721": {
+ "qualifiedName": "T",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1722": {
+ "qualifiedName": "to_seconds",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1726": {
+ "qualifiedName": "catch_not_found_or_throw",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1729": {
+ "qualifiedName": "catch_not_found_for_resource_or_throw",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1733": {
+ "qualifiedName": "encode_key_value_store_record_value",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1737": {
+ "qualifiedName": "is_retryable_error",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1740": {
+ "qualifiedName": "to_safe_id",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1743": {
+ "qualifiedName": "response_to_dict",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1746": {
+ "qualifiedName": "response_to_list",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1749": {
+ "qualifiedName": "encode_base62",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1752": {
+ "qualifiedName": "create_hmac_signature",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1756": {
+ "qualifiedName": "create_storage_content_signature",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1762": {
+ "qualifiedName": "check_custom_headers",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1766": {
+ "qualifiedName": "encode_webhooks_to_base64",
+ "sourceFileName": "/src/apify_client/_utils.py"
+ },
+ "1769": {
+ "qualifiedName": "StatusMessageWatcherBase",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1770": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1774": {
+ "qualifiedName": "StatusMessageWatcherAsync",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1775": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1780": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1782": {
+ "qualifiedName": "stop",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1784": {
+ "qualifiedName": "__aenter__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1786": {
+ "qualifiedName": "__aexit__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1791": {
+ "qualifiedName": "StatusMessageWatcher",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1792": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1797": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1799": {
+ "qualifiedName": "stop",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1801": {
+ "qualifiedName": "__enter__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1803": {
+ "qualifiedName": "__exit__",
+ "sourceFileName": "/src/apify_client/_status_message_watcher.py"
+ },
+ "1808": {
+ "qualifiedName": "ClientRegistry",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1809": {
+ "qualifiedName": "actor_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1810": {
+ "qualifiedName": "actor_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1811": {
+ "qualifiedName": "actor_env_var_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1812": {
+ "qualifiedName": "actor_env_var_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1813": {
+ "qualifiedName": "actor_version_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1814": {
+ "qualifiedName": "actor_version_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1815": {
+ "qualifiedName": "build_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1816": {
+ "qualifiedName": "build_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1817": {
+ "qualifiedName": "dataset_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1818": {
+ "qualifiedName": "dataset_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1819": {
+ "qualifiedName": "key_value_store_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1820": {
+ "qualifiedName": "key_value_store_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1821": {
+ "qualifiedName": "log_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1822": {
+ "qualifiedName": "request_queue_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1823": {
+ "qualifiedName": "request_queue_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1824": {
+ "qualifiedName": "run_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1825": {
+ "qualifiedName": "run_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1826": {
+ "qualifiedName": "schedule_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1827": {
+ "qualifiedName": "schedule_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1828": {
+ "qualifiedName": "store_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1829": {
+ "qualifiedName": "task_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1830": {
+ "qualifiedName": "task_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1831": {
+ "qualifiedName": "user_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1832": {
+ "qualifiedName": "webhook_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1833": {
+ "qualifiedName": "webhook_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1834": {
+ "qualifiedName": "webhook_dispatch_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1835": {
+ "qualifiedName": "webhook_dispatch_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1836": {
+ "qualifiedName": "ClientRegistryAsync",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1837": {
+ "qualifiedName": "actor_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1838": {
+ "qualifiedName": "actor_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1839": {
+ "qualifiedName": "actor_env_var_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1840": {
+ "qualifiedName": "actor_env_var_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1841": {
+ "qualifiedName": "actor_version_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1842": {
+ "qualifiedName": "actor_version_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1843": {
+ "qualifiedName": "build_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1844": {
+ "qualifiedName": "build_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1845": {
+ "qualifiedName": "dataset_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1846": {
+ "qualifiedName": "dataset_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1847": {
+ "qualifiedName": "key_value_store_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1848": {
+ "qualifiedName": "key_value_store_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1849": {
+ "qualifiedName": "log_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1850": {
+ "qualifiedName": "request_queue_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1851": {
+ "qualifiedName": "request_queue_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1852": {
+ "qualifiedName": "run_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1853": {
+ "qualifiedName": "run_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1854": {
+ "qualifiedName": "schedule_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1855": {
+ "qualifiedName": "schedule_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1856": {
+ "qualifiedName": "store_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1857": {
+ "qualifiedName": "task_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1858": {
+ "qualifiedName": "task_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1859": {
+ "qualifiedName": "user_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1860": {
+ "qualifiedName": "webhook_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1861": {
+ "qualifiedName": "webhook_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1862": {
+ "qualifiedName": "webhook_dispatch_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1863": {
+ "qualifiedName": "webhook_dispatch_collection_client",
+ "sourceFileName": "/src/apify_client/_client_registry.py"
+ },
+ "1864": {
+ "qualifiedName": "T",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1865": {
+ "qualifiedName": "DEFAULT_CHUNK_SIZE",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1866": {
+ "qualifiedName": "HasItems",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1867": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1868": {
+ "qualifiedName": "get_items_iterator",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1874": {
+ "qualifiedName": "get_items_iterator_async",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1880": {
+ "qualifiedName": "get_cursor_iterator",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1886": {
+ "qualifiedName": "get_cursor_iterator_async",
+ "sourceFileName": "/src/apify_client/_pagination.py"
+ },
+ "1892": {
+ "qualifiedName": "ActorJobStatus",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1893": {
+ "qualifiedName": "ActorPermissionLevel",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1894": {
+ "qualifiedName": "ErrorType",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1895": {
+ "qualifiedName": "GeneralAccess",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1896": {
+ "qualifiedName": "HttpMethod",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1897": {
+ "qualifiedName": "RunOrigin",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1898": {
+ "qualifiedName": "SourceCodeFileFormat",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1899": {
+ "qualifiedName": "StorageOwnership",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1900": {
+ "qualifiedName": "VersionSourceType",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1901": {
+ "qualifiedName": "WebhookDispatchStatus",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1902": {
+ "qualifiedName": "WebhookEventType",
+ "sourceFileName": "/src/apify_client/_literals.py"
+ },
+ "1903": {
+ "qualifiedName": "HttpResponse",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1904": {
+ "qualifiedName": "status_code",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1905": {
+ "qualifiedName": "text",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1906": {
+ "qualifiedName": "content",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1907": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1908": {
+ "qualifiedName": "json",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1910": {
+ "qualifiedName": "read",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1912": {
+ "qualifiedName": "aread",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1914": {
+ "qualifiedName": "close",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1916": {
+ "qualifiedName": "aclose",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1918": {
+ "qualifiedName": "iter_bytes",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1920": {
+ "qualifiedName": "aiter_bytes",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1922": {
+ "qualifiedName": "HttpClientBase",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1923": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1934": {
+ "qualifiedName": "HttpClient",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1935": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1945": {
+ "qualifiedName": "HttpClientAsync",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1946": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "1956": {
+ "qualifiedName": "T",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1957": {
+ "qualifiedName": "logger",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1958": {
+ "qualifiedName": "ImpitHttpClient",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1959": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1970": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1980": {
+ "qualifiedName": "ImpitHttpClientAsync",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1981": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "1992": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/http_clients/_impit.py"
+ },
+ "2002": {
+ "qualifiedName": "ScheduleClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2003": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2008": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2011": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2022": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2025": {
+ "qualifiedName": "get_log",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2028": {
+ "qualifiedName": "ScheduleClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2029": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2034": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2037": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2048": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2051": {
+ "qualifiedName": "get_log",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule.py"
+ },
+ "2054": {
+ "qualifiedName": "UserClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2055": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2060": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2063": {
+ "qualifiedName": "monthly_usage",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2066": {
+ "qualifiedName": "limits",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2069": {
+ "qualifiedName": "update_limits",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2074": {
+ "qualifiedName": "UserClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2075": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2080": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2083": {
+ "qualifiedName": "monthly_usage",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2086": {
+ "qualifiedName": "limits",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2089": {
+ "qualifiedName": "update_limits",
+ "sourceFileName": "/src/apify_client/_resource_clients/user.py"
+ },
+ "2094": {
+ "qualifiedName": "RequestQueueClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2095": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2101": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2104": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2109": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2112": {
+ "qualifiedName": "list_head",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2116": {
+ "qualifiedName": "list_and_lock_head",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2121": {
+ "qualifiedName": "add_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2126": {
+ "qualifiedName": "get_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2130": {
+ "qualifiedName": "update_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2135": {
+ "qualifiedName": "delete_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2139": {
+ "qualifiedName": "prolong_request_lock",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2145": {
+ "qualifiedName": "delete_request_lock",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2150": {
+ "qualifiedName": "batch_add_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2156": {
+ "qualifiedName": "batch_delete_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2160": {
+ "qualifiedName": "list_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2166": {
+ "qualifiedName": "iterate_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2173": {
+ "qualifiedName": "unlock_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2176": {
+ "qualifiedName": "RequestQueueClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2177": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2183": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2186": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2191": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2194": {
+ "qualifiedName": "list_head",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2198": {
+ "qualifiedName": "list_and_lock_head",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2203": {
+ "qualifiedName": "add_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2208": {
+ "qualifiedName": "get_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2212": {
+ "qualifiedName": "update_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2217": {
+ "qualifiedName": "delete_request",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2221": {
+ "qualifiedName": "prolong_request_lock",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2227": {
+ "qualifiedName": "delete_request_lock",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2232": {
+ "qualifiedName": "batch_add_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2238": {
+ "qualifiedName": "batch_delete_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2242": {
+ "qualifiedName": "list_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2248": {
+ "qualifiedName": "iterate_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2255": {
+ "qualifiedName": "unlock_requests",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py"
+ },
+ "2258": {
+ "qualifiedName": "LogClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2259": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2263": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2267": {
+ "qualifiedName": "get_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2271": {
+ "qualifiedName": "stream",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2275": {
+ "qualifiedName": "LogClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2276": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2280": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2284": {
+ "qualifiedName": "get_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2288": {
+ "qualifiedName": "stream",
+ "sourceFileName": "/src/apify_client/_resource_clients/log.py"
+ },
+ "2292": {
+ "qualifiedName": "ActorEnvVarCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2293": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2297": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2300": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2303": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2309": {
+ "qualifiedName": "ActorEnvVarCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2310": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2314": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2317": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2320": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py"
+ },
+ "2326": {
+ "qualifiedName": "WebhookDispatchCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2327": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2331": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2337": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2343": {
+ "qualifiedName": "WebhookDispatchCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2344": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2348": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2354": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py"
+ },
+ "2360": {
+ "qualifiedName": "ActorCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2361": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2365": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2373": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2381": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2406": {
+ "qualifiedName": "ActorCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2407": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2411": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2419": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2427": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py"
+ },
+ "2452": {
+ "qualifiedName": "WebhookDispatchClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2453": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2458": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2461": {
+ "qualifiedName": "WebhookDispatchClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2462": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2467": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py"
+ },
+ "2470": {
+ "qualifiedName": "KeyValueStoreCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2471": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2475": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2483": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2491": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2496": {
+ "qualifiedName": "KeyValueStoreCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2497": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2501": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2509": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2517": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py"
+ },
+ "2522": {
+ "qualifiedName": "ActorVersionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2523": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2528": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2531": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2542": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2545": {
+ "qualifiedName": "env_vars",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2547": {
+ "qualifiedName": "env_var",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2550": {
+ "qualifiedName": "ActorVersionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2551": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2556": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2559": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2570": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2573": {
+ "qualifiedName": "env_vars",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2575": {
+ "qualifiedName": "env_var",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py"
+ },
+ "2578": {
+ "qualifiedName": "RequestQueueCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2579": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2583": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2591": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2599": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2603": {
+ "qualifiedName": "RequestQueueCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2604": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2608": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2616": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2624": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py"
+ },
+ "2628": {
+ "qualifiedName": "TaskCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2629": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2633": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2639": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2645": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2662": {
+ "qualifiedName": "TaskCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2663": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2667": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2673": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2679": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py"
+ },
+ "2696": {
+ "qualifiedName": "StoreCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2697": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2701": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2711": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2721": {
+ "qualifiedName": "StoreCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2722": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2726": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2736": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py"
+ },
+ "2746": {
+ "qualifiedName": "TaskClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2747": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2752": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2755": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2771": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2774": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2785": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2796": {
+ "qualifiedName": "get_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2799": {
+ "qualifiedName": "update_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2803": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2805": {
+ "qualifiedName": "last_run",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2809": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2811": {
+ "qualifiedName": "TaskClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2812": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2817": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2820": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2836": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2839": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2850": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2861": {
+ "qualifiedName": "get_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2864": {
+ "qualifiedName": "update_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2868": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2870": {
+ "qualifiedName": "last_run",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2874": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_resource_clients/task.py"
+ },
+ "2876": {
+ "qualifiedName": "BuildCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2877": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2881": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2887": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2893": {
+ "qualifiedName": "BuildCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2894": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2898": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2904": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py"
+ },
+ "2910": {
+ "qualifiedName": "DatasetItemsPage",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2911": {
+ "qualifiedName": "items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2912": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2913": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2914": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2915": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2916": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2917": {
+ "qualifiedName": "DatasetClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2918": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2923": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2926": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2931": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2934": {
+ "qualifiedName": "list_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2949": {
+ "qualifiedName": "iterate_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2963": {
+ "qualifiedName": "get_items_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "2983": {
+ "qualifiedName": "stream_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3002": {
+ "qualifiedName": "push_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3006": {
+ "qualifiedName": "get_statistics",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3009": {
+ "qualifiedName": "create_items_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3024": {
+ "qualifiedName": "DatasetClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3025": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3030": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3033": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3038": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3041": {
+ "qualifiedName": "list_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3056": {
+ "qualifiedName": "iterate_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3070": {
+ "qualifiedName": "get_items_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3090": {
+ "qualifiedName": "stream_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3109": {
+ "qualifiedName": "push_items",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3113": {
+ "qualifiedName": "get_statistics",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3116": {
+ "qualifiedName": "create_items_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset.py"
+ },
+ "3131": {
+ "qualifiedName": "RunClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3132": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3137": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3140": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3146": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3149": {
+ "qualifiedName": "abort",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3153": {
+ "qualifiedName": "wait_for_finish",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3157": {
+ "qualifiedName": "metamorph",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3164": {
+ "qualifiedName": "resurrect",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3173": {
+ "qualifiedName": "reboot",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3176": {
+ "qualifiedName": "dataset",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3178": {
+ "qualifiedName": "key_value_store",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3180": {
+ "qualifiedName": "request_queue",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3182": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3184": {
+ "qualifiedName": "get_streamed_log",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3189": {
+ "qualifiedName": "charge",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3195": {
+ "qualifiedName": "get_status_message_watcher",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3200": {
+ "qualifiedName": "RunClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3201": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3206": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3209": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3215": {
+ "qualifiedName": "abort",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3219": {
+ "qualifiedName": "wait_for_finish",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3223": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3226": {
+ "qualifiedName": "metamorph",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3233": {
+ "qualifiedName": "resurrect",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3242": {
+ "qualifiedName": "reboot",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3245": {
+ "qualifiedName": "dataset",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3247": {
+ "qualifiedName": "key_value_store",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3249": {
+ "qualifiedName": "request_queue",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3251": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3253": {
+ "qualifiedName": "get_streamed_log",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3258": {
+ "qualifiedName": "charge",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3264": {
+ "qualifiedName": "get_status_message_watcher",
+ "sourceFileName": "/src/apify_client/_resource_clients/run.py"
+ },
+ "3269": {
+ "qualifiedName": "BuildClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3270": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3275": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3278": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3281": {
+ "qualifiedName": "abort",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3284": {
+ "qualifiedName": "get_open_api_definition",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3287": {
+ "qualifiedName": "wait_for_finish",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3291": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3293": {
+ "qualifiedName": "BuildClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3294": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3299": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3302": {
+ "qualifiedName": "abort",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3305": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3308": {
+ "qualifiedName": "get_open_api_definition",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3311": {
+ "qualifiedName": "wait_for_finish",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3315": {
+ "qualifiedName": "log",
+ "sourceFileName": "/src/apify_client/_resource_clients/build.py"
+ },
+ "3317": {
+ "qualifiedName": "ScheduleCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3318": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3322": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3328": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3334": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3345": {
+ "qualifiedName": "ScheduleCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3346": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3350": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3356": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3362": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py"
+ },
+ "3373": {
+ "qualifiedName": "ActorVersionCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3374": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3378": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3381": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3384": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3396": {
+ "qualifiedName": "ActorVersionCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3397": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3401": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3404": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3407": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py"
+ },
+ "3419": {
+ "qualifiedName": "DatasetCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3420": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3424": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3432": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3440": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3445": {
+ "qualifiedName": "DatasetCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3446": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3450": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3458": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3466": {
+ "qualifiedName": "get_or_create",
+ "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py"
+ },
+ "3471": {
+ "qualifiedName": "ResourceClientBase",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3472": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3481": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3482": {
+ "qualifiedName": "ResourceClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3483": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3492": {
+ "qualifiedName": "ResourceClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3493": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "3502": {
+ "qualifiedName": "ActorClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3503": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3508": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3511": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3539": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3542": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3556": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3571": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3579": {
+ "qualifiedName": "builds",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3581": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3583": {
+ "qualifiedName": "default_build",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3587": {
+ "qualifiedName": "last_run",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3591": {
+ "qualifiedName": "versions",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3593": {
+ "qualifiedName": "version",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3596": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3598": {
+ "qualifiedName": "validate_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3604": {
+ "qualifiedName": "ActorClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3605": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3610": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3613": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3641": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3644": {
+ "qualifiedName": "start",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3658": {
+ "qualifiedName": "call",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3673": {
+ "qualifiedName": "build",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3681": {
+ "qualifiedName": "builds",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3683": {
+ "qualifiedName": "runs",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3685": {
+ "qualifiedName": "default_build",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3689": {
+ "qualifiedName": "last_run",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3693": {
+ "qualifiedName": "versions",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3695": {
+ "qualifiedName": "version",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3698": {
+ "qualifiedName": "webhooks",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3700": {
+ "qualifiedName": "validate_input",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor.py"
+ },
+ "3706": {
+ "qualifiedName": "KeyValueStoreClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3707": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3712": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3715": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3720": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3723": {
+ "qualifiedName": "list_keys",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3731": {
+ "qualifiedName": "iterate_keys",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3740": {
+ "qualifiedName": "get_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3745": {
+ "qualifiedName": "record_exists",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3749": {
+ "qualifiedName": "get_record_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3754": {
+ "qualifiedName": "stream_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3759": {
+ "qualifiedName": "set_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3765": {
+ "qualifiedName": "delete_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3769": {
+ "qualifiedName": "get_record_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3773": {
+ "qualifiedName": "create_keys_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3781": {
+ "qualifiedName": "KeyValueStoreClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3782": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3787": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3790": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3795": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3798": {
+ "qualifiedName": "list_keys",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3806": {
+ "qualifiedName": "iterate_keys",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3815": {
+ "qualifiedName": "get_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3820": {
+ "qualifiedName": "record_exists",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3824": {
+ "qualifiedName": "get_record_as_bytes",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3829": {
+ "qualifiedName": "stream_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3834": {
+ "qualifiedName": "set_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3840": {
+ "qualifiedName": "delete_record",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3844": {
+ "qualifiedName": "get_record_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3848": {
+ "qualifiedName": "create_keys_public_url",
+ "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py"
+ },
+ "3856": {
+ "qualifiedName": "ActorEnvVarClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3857": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3862": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3865": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3871": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3874": {
+ "qualifiedName": "ActorEnvVarClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3875": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3880": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3883": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3889": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py"
+ },
+ "3892": {
+ "qualifiedName": "WebhookCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3893": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3897": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3903": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3909": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3923": {
+ "qualifiedName": "WebhookCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3924": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3928": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3934": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3940": {
+ "qualifiedName": "create",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py"
+ },
+ "3954": {
+ "qualifiedName": "WebhookClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3955": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3960": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3963": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3976": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3979": {
+ "qualifiedName": "test",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3982": {
+ "qualifiedName": "dispatches",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3984": {
+ "qualifiedName": "WebhookClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3985": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3990": {
+ "qualifiedName": "get",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "3993": {
+ "qualifiedName": "update",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "4006": {
+ "qualifiedName": "delete",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "4009": {
+ "qualifiedName": "test",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "4012": {
+ "qualifiedName": "dispatches",
+ "sourceFileName": "/src/apify_client/_resource_clients/webhook.py"
+ },
+ "4014": {
+ "qualifiedName": "RunCollectionClient",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4015": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4019": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4028": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4037": {
+ "qualifiedName": "RunCollectionClientAsync",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4038": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4042": {
+ "qualifiedName": "list",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4051": {
+ "qualifiedName": "iterate",
+ "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py"
+ },
+ "4060": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4061": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4062": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4063": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4064": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4065": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4066": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4067": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4068": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4069": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4070": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4071": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4072": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4073": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4074": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4075": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4076": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4077": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4078": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4079": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4080": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4081": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4082": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4083": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4084": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4085": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4086": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4087": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4088": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4089": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4090": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4091": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4092": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4093": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4094": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4095": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4096": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4097": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4098": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4099": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4100": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4101": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4102": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4103": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4104": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4105": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4106": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4107": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4108": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4109": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4110": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4111": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4112": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4113": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4114": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4115": {
+ "qualifiedName": "resource_id",
+ "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py"
+ },
+ "4116": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "4117": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/http_clients/_base.py"
+ },
+ "4118": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4119": {
+ "qualifiedName": "data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4120": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4121": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4122": {
+ "qualifiedName": "general_access",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4123": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4124": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4125": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4126": {
+ "qualifiedName": "cron_expression",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4127": {
+ "qualifiedName": "timezone",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4128": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4129": {
+ "qualifiedName": "is_exclusive",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4130": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4131": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4132": {
+ "qualifiedName": "next_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4133": {
+ "qualifiedName": "last_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4134": {
+ "qualifiedName": "id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4135": {
+ "qualifiedName": "user_id",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4136": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4137": {
+ "qualifiedName": "cron_expression",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4138": {
+ "qualifiedName": "timezone",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4139": {
+ "qualifiedName": "is_enabled",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4140": {
+ "qualifiedName": "is_exclusive",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4141": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4142": {
+ "qualifiedName": "modified_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4143": {
+ "qualifiedName": "next_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4144": {
+ "qualifiedName": "last_run_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4145": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4146": {
+ "qualifiedName": "message",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4147": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4148": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4149": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4150": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4151": {
+ "qualifiedName": "loaded_url",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4152": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4153": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4154": {
+ "qualifiedName": "user_data",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4155": {
+ "qualifiedName": "no_retry",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4156": {
+ "qualifiedName": "error_messages",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4157": {
+ "qualifiedName": "handled_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4158": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4159": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4160": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4161": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4162": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4163": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4164": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4165": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4166": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4167": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4168": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4169": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4170": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4171": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4172": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4173": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4174": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4175": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4176": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4177": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4178": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4179": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4180": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4181": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4182": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4183": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4184": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4185": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4186": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4187": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4188": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4189": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4190": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4191": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4192": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4193": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4194": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4195": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4196": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4197": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4198": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4199": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4200": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4201": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4202": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4203": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4204": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4205": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4206": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4207": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4208": {
+ "qualifiedName": "total",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4209": {
+ "qualifiedName": "offset",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4210": {
+ "qualifiedName": "limit",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4211": {
+ "qualifiedName": "desc",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4212": {
+ "qualifiedName": "count",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4213": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4214": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4215": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4216": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4217": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4218": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4219": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4220": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4221": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4222": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4223": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4224": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4225": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4226": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4227": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4228": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4229": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4230": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4231": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4232": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4233": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4234": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4235": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4236": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4237": {
+ "qualifiedName": "apify_margin_percentage",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4238": {
+ "qualifiedName": "created_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4239": {
+ "qualifiedName": "started_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4240": {
+ "qualifiedName": "notified_about_future_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4241": {
+ "qualifiedName": "notified_about_change_at",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4242": {
+ "qualifiedName": "reason_for_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4243": {
+ "qualifiedName": "is_price_change_notification_suppressed",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4244": {
+ "qualifiedName": "force_contains_significant_price_change",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4245": {
+ "qualifiedName": "name",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4246": {
+ "qualifiedName": "value",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4247": {
+ "qualifiedName": "is_secret",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4248": {
+ "qualifiedName": "model_config",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4249": {
+ "qualifiedName": "encoded",
+ "sourceFileName": "/src/apify_client/_models.py"
+ },
+ "4250": {
+ "qualifiedName": "uniqueKey",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4251": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4252": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4253": {
+ "qualifiedName": "retryCount",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4254": {
+ "qualifiedName": "loadedUrl",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4255": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4256": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4257": {
+ "qualifiedName": "userData",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4258": {
+ "qualifiedName": "noRetry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4259": {
+ "qualifiedName": "errorMessages",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4260": {
+ "qualifiedName": "handledAt",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4261": {
+ "qualifiedName": "unique_key",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4262": {
+ "qualifiedName": "url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4263": {
+ "qualifiedName": "method",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4264": {
+ "qualifiedName": "retry_count",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4265": {
+ "qualifiedName": "loaded_url",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4266": {
+ "qualifiedName": "payload",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4267": {
+ "qualifiedName": "headers",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4268": {
+ "qualifiedName": "user_data",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4269": {
+ "qualifiedName": "no_retry",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4270": {
+ "qualifiedName": "error_messages",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4271": {
+ "qualifiedName": "handled_at",
+ "sourceFileName": "/src/apify_client/_typeddicts.py"
+ },
+ "4272": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4273": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4274": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4275": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4276": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4277": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4278": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4279": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4280": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4281": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4282": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4283": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4284": {
+ "qualifiedName": "__new__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ },
+ "4285": {
+ "qualifiedName": "__init__",
+ "sourceFileName": "/src/apify_client/errors.py"
+ }
+ },
+ "overloads": [
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 34
+ },
+ "name": "td",
+ "type": "POSITIONAL",
+ "datatype": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 34
+ },
+ "name": "as_int",
+ "type": "KEYWORD_ONLY",
+ "datatype": "bool",
+ "default_value": "..."
+ }
+ ],
+ "return_type": "None",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 33
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 34
+ },
+ "name": "to_seconds",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 36
+ },
+ "name": "td",
+ "type": "POSITIONAL",
+ "datatype": "timedelta"
+ }
+ ],
+ "return_type": "float",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 35
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 36
+ },
+ "name": "to_seconds",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 38
+ },
+ "name": "td",
+ "type": "POSITIONAL",
+ "datatype": "timedelta"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 38
+ },
+ "name": "as_int",
+ "type": "KEYWORD_ONLY",
+ "datatype": "Literal[True]"
+ }
+ ],
+ "return_type": "int",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 37
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 38
+ },
+ "name": "to_seconds",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 40
+ },
+ "name": "td",
+ "type": "POSITIONAL",
+ "datatype": "timedelta"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 40
+ },
+ "name": "as_int",
+ "type": "KEYWORD_ONLY",
+ "datatype": "Literal[False]"
+ }
+ ],
+ "return_type": "float",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 39
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py",
+ "lineno": 40
+ },
+ "name": "to_seconds",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 103
+ },
+ "name": "callback",
+ "type": "POSITIONAL",
+ "datatype": "Callable[..., ListOfKeys]"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 105
+ },
+ "name": "cursor",
+ "type": "KEYWORD_ONLY",
+ "datatype": "str | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 106
+ },
+ "name": "limit",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 107
+ },
+ "name": "chunk_size",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ }
+ ],
+ "return_type": "Iterator[KeyValueStoreKey]",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 101
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 102
+ },
+ "name": "get_cursor_iterator",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 111
+ },
+ "name": "callback",
+ "type": "POSITIONAL",
+ "datatype": "Callable[..., ListOfRequests]"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 113
+ },
+ "name": "cursor",
+ "type": "KEYWORD_ONLY",
+ "datatype": "str | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 114
+ },
+ "name": "limit",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 115
+ },
+ "name": "chunk_size",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ }
+ ],
+ "return_type": "Iterator[Request]",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 109
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 110
+ },
+ "name": "get_cursor_iterator",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 158
+ },
+ "name": "callback",
+ "type": "POSITIONAL",
+ "datatype": "Callable[..., Awaitable[ListOfKeys]]"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 160
+ },
+ "name": "cursor",
+ "type": "KEYWORD_ONLY",
+ "datatype": "str | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 161
+ },
+ "name": "limit",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 162
+ },
+ "name": "chunk_size",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ }
+ ],
+ "return_type": "AsyncIterator[KeyValueStoreKey]",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 156
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 157
+ },
+ "name": "get_cursor_iterator_async",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ },
+ {
+ "args": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 166
+ },
+ "name": "callback",
+ "type": "POSITIONAL",
+ "datatype": "Callable[..., Awaitable[ListOfRequests]]"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 168
+ },
+ "name": "cursor",
+ "type": "KEYWORD_ONLY",
+ "datatype": "str | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 169
+ },
+ "name": "limit",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ },
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 170
+ },
+ "name": "chunk_size",
+ "type": "KEYWORD_ONLY",
+ "datatype": "int | None",
+ "default_value": "None"
+ }
+ ],
+ "return_type": "AsyncIterator[Request]",
+ "decorations": [
+ {
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 164
+ },
+ "name": "overload"
+ }
+ ],
+ "location": {
+ "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py",
+ "lineno": 165
+ },
+ "name": "get_cursor_iterator_async",
+ "type": "function",
+ "parsedDocstring": {
+ "text": ""
+ }
+ }
+ ]
+}
\ No newline at end of file
diff --git a/website/versioned_sidebars/version-3.0-sidebars.json b/website/versioned_sidebars/version-3.0-sidebars.json
new file mode 100644
index 00000000..b90b80de
--- /dev/null
+++ b/website/versioned_sidebars/version-3.0-sidebars.json
@@ -0,0 +1,45 @@
+{
+ "sidebar": [
+ {
+ "type": "doc",
+ "id": "introduction/introduction"
+ },
+ {
+ "type": "doc",
+ "id": "introduction/quick-start"
+ },
+ {
+ "type": "category",
+ "label": "Concepts",
+ "collapsed": true,
+ "items": [
+ {
+ "type": "autogenerated",
+ "dirName": "02_concepts"
+ }
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Guides",
+ "collapsed": true,
+ "items": [
+ {
+ "type": "autogenerated",
+ "dirName": "03_guides"
+ }
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Upgrading",
+ "collapsed": true,
+ "items": [
+ {
+ "type": "autogenerated",
+ "dirName": "04_upgrading"
+ }
+ ]
+ }
+ ]
+}
diff --git a/website/versions.json b/website/versions.json
index 1b8739b1..c03bda61 100644
--- a/website/versions.json
+++ b/website/versions.json
@@ -1 +1,6 @@
-["2.5", "1.12", "0.6"]
+[
+ "3.0",
+ "2.5",
+ "1.12",
+ "0.6"
+]