From e16272727bd78c8aa2a0ac13d6b5f81f63540dab Mon Sep 17 00:00:00 2001 From: Tsitsi Nyamutswa <128546813+tnyamutswa@users.noreply.github.com> Date: Thu, 5 Nov 2026 14:59:35 +0100 Subject: [PATCH 1/2] docs: add deprecation banner to all docs pages --- README.md | 23 ++++++++++--------- VERSIONS.md | 7 ++++++ docs/README.md | 7 ++++++ docs/ai.md | 7 ++++++ docs/ai_studio.md | 7 ++++++ docs/app_item_associations.md | 7 ++++++ docs/archives.md | 7 ++++++ docs/authentication.md | 7 ++++++ docs/authorization.md | 7 ++++++ docs/avatars.md | 7 ++++++ docs/chunked_uploads.md | 7 ++++++ docs/classifications.md | 7 ++++++ docs/client.md | 7 ++++++ docs/collaboration_allowlist_entries.md | 7 ++++++ .../collaboration_allowlist_exempt_targets.md | 7 ++++++ docs/collections.md | 7 ++++++ docs/comments.md | 7 ++++++ docs/configuration.md | 7 ++++++ docs/device_pinners.md | 7 ++++++ docs/docgen.md | 7 ++++++ docs/docgen_template.md | 7 ++++++ docs/downloads.md | 7 ++++++ docs/email_aliases.md | 7 ++++++ docs/event-stream.md | 7 ++++++ docs/events.md | 7 ++++++ docs/file_classifications.md | 7 ++++++ docs/file_metadata.md | 7 ++++++ docs/file_requests.md | 7 ++++++ docs/file_version_legal_holds.md | 7 ++++++ docs/file_version_retentions.md | 7 ++++++ docs/file_versions.md | 7 ++++++ docs/file_watermarks.md | 7 ++++++ docs/files.md | 7 ++++++ docs/folder_classifications.md | 7 ++++++ docs/folder_locks.md | 7 ++++++ docs/folder_metadata.md | 7 ++++++ docs/folder_watermarks.md | 7 ++++++ docs/folders.md | 7 ++++++ docs/groups.md | 7 ++++++ docs/hub_collaborations.md | 7 ++++++ docs/hub_items.md | 7 ++++++ docs/hubs.md | 7 ++++++ docs/integration_mappings.md | 7 ++++++ docs/invites.md | 7 ++++++ docs/legal_hold_policies.md | 7 ++++++ docs/legal_hold_policy_assignments.md | 7 ++++++ docs/list_collaborations.md | 7 ++++++ docs/memberships.md | 7 ++++++ docs/metadata_cascade_policies.md | 7 ++++++ docs/metadata_templates.md | 7 ++++++ docs/recent_items.md | 7 ++++++ docs/retention_policies.md | 7 ++++++ docs/retention_policy_assignments.md | 7 ++++++ docs/search.md | 7 ++++++ docs/session_termination.md | 7 ++++++ docs/shared_links_app_items.md | 7 ++++++ docs/shared_links_files.md | 7 ++++++ docs/shared_links_folders.md | 7 ++++++ docs/shared_links_web_links.md | 7 ++++++ docs/shield_information_barrier_reports.md | 7 ++++++ ...eld_information_barrier_segment_members.md | 7 ++++++ ...nformation_barrier_segment_restrictions.md | 7 ++++++ docs/shield_information_barrier_segments.md | 7 ++++++ docs/shield_information_barriers.md | 7 ++++++ docs/shield_lists.md | 7 ++++++ docs/sign_requests.md | 7 ++++++ docs/sign_templates.md | 7 ++++++ docs/skills.md | 7 ++++++ docs/storage_policies.md | 7 ++++++ docs/storage_policy_assignments.md | 7 ++++++ docs/task_assignments.md | 7 ++++++ docs/tasks.md | 7 ++++++ docs/terms_of_service_user_statuses.md | 7 ++++++ docs/terms_of_services.md | 7 ++++++ docs/transfer.md | 7 ++++++ docs/trashed_files.md | 7 ++++++ docs/trashed_folders.md | 7 ++++++ docs/trashed_items.md | 7 ++++++ docs/trashed_web_links.md | 7 ++++++ docs/uploads.md | 7 ++++++ docs/user_collaborations.md | 7 ++++++ docs/users.md | 7 ++++++ docs/web_links.md | 7 ++++++ docs/webhooks.md | 7 ++++++ docs/workflows.md | 7 ++++++ docs/working-with-nulls.md | 7 ++++++ docs/zip_downloads.md | 7 ++++++ migration-guide.md | 7 ++++++ 88 files changed, 621 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 15be0e7e..5f2a6deb 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ # Deprecation notice +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained. Do not use it for new projects.** +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + As of September 17, 2025, Box Next Generation SDKs are no longer supported as separate artifacts. Your existing code will continue to work without changes, but you won't receive new features, updates, bug fixes, or security patches. In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package. This makes migration easier and allows you to seamlessly add new capabilities to existing applications. Two consolidated versions are available in [box-python-sdk](https://github.com/box/box-python-sdk): @@ -22,17 +28,7 @@ For more details, see our [SDK versioning strategy document](https://developer.b ![Platform](https://img.shields.io/badge/python-3.8+-blue) [![Coverage](https://coveralls.io/repos/github/box/box-python-sdk-gen/badge.svg?branch=main)](https://coveralls.io/github/box/box-python-sdk-gen?branch=main) -We are excited to introduce the stable release of the latest generation of Box Python SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud. - -With this SDK, you’ll have access to: - -1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications. -2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. -3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process. -4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more. -5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic. - -Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud. +This library provides access to the [Box Platform API](https://developer.box.com/reference/) from Python. # Table of contents @@ -57,6 +53,9 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box # Installing +> [!CAUTION] +> This package is deprecated. For new projects, install [`box-python-sdk`](https://github.com/box/box-python-sdk) instead: `pip install "boxsdk>=10"`. + ```console pip install box-sdk-gen ``` @@ -98,6 +97,8 @@ if __name__ == '__main__': Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information. +For `box-python-sdk`, the maintained replacement for this package, see its [README](https://github.com/box/box-python-sdk/blob/main/README.md) and [docs](https://github.com/box/box-python-sdk/blob/main/docs/README.md). + # Upgrades Upgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our [migration guide](migration-guide.md) and [changelog](CHANGELOG.md) for more information. diff --git a/VERSIONS.md b/VERSIONS.md index 45c97203..58ba2bf5 100644 --- a/VERSIONS.md +++ b/VERSIONS.md @@ -1,5 +1,12 @@ # Version Lifecycle + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/VERSIONS.md](https://github.com/box/box-python-sdk/blob/main/VERSIONS.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. It is strongly encouraged that you pin at least the major version and potentially the minor version to avoid pulling in breaking changes. Increasing the major version of an SDK indicates that this SDK underwent significant and substantial changes to support new idioms and patterns in the language. Major versions are introduced when public interfaces (e.g. classes, methods, types, etc.), behaviours, or semantics have changed. Semantic Versions take the form of `MAJOR.MINOR.PATCH`. diff --git a/docs/README.md b/docs/README.md index 7b54f27b..a927c4a7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,12 @@ # Documentation + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/README.md](https://github.com/box/box-python-sdk/blob/main/docs/README.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + ## High-level Documentation General explanations of the available functionality and examples of how to use diff --git a/docs/ai.md b/docs/ai.md index 59784e91..f8c0979f 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -1,5 +1,12 @@ # AiManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/ai.md](https://github.com/box/box-python-sdk/blob/main/docs/ai.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Ask question](#ask-question) - [Generate text](#generate-text) - [Get AI agent default configuration](#get-ai-agent-default-configuration) diff --git a/docs/ai_studio.md b/docs/ai_studio.md index 92e42046..ceab6e62 100644 --- a/docs/ai_studio.md +++ b/docs/ai_studio.md @@ -1,5 +1,12 @@ # AiStudioManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/ai_studio.md](https://github.com/box/box-python-sdk/blob/main/docs/ai_studio.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List AI agents](#list-ai-agents) - [Create AI agent](#create-ai-agent) - [Update AI agent](#update-ai-agent) diff --git a/docs/app_item_associations.md b/docs/app_item_associations.md index 371483db..74239f90 100644 --- a/docs/app_item_associations.md +++ b/docs/app_item_associations.md @@ -1,5 +1,12 @@ # AppItemAssociationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/app_item_associations.md](https://github.com/box/box-python-sdk/blob/main/docs/app_item_associations.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List file app item associations](#list-file-app-item-associations) - [List folder app item associations](#list-folder-app-item-associations) diff --git a/docs/archives.md b/docs/archives.md index cc730a34..0f4c3bf9 100644 --- a/docs/archives.md +++ b/docs/archives.md @@ -1,5 +1,12 @@ # ArchivesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/archives.md](https://github.com/box/box-python-sdk/blob/main/docs/archives.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List archives](#list-archives) - [Create archive](#create-archive) - [Delete archive](#delete-archive) diff --git a/docs/authentication.md b/docs/authentication.md index cbe78f30..9284cfdb 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,5 +1,12 @@ # Authentication + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/authentication.md](https://github.com/box/box-python-sdk/blob/main/docs/authentication.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + diff --git a/docs/authorization.md b/docs/authorization.md index 65da2275..edb39d78 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -1,5 +1,12 @@ # AuthorizationManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/authorization.md](https://github.com/box/box-python-sdk/blob/main/docs/authorization.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Authorize user](#authorize-user) - [Request access token](#request-access-token) - [Refresh access token](#refresh-access-token) diff --git a/docs/avatars.md b/docs/avatars.md index 702da504..46d88e20 100644 --- a/docs/avatars.md +++ b/docs/avatars.md @@ -1,5 +1,12 @@ # AvatarsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/avatars.md](https://github.com/box/box-python-sdk/blob/main/docs/avatars.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get user avatar](#get-user-avatar) - [Add or update user avatar](#add-or-update-user-avatar) - [Delete user avatar](#delete-user-avatar) diff --git a/docs/chunked_uploads.md b/docs/chunked_uploads.md index 2d965c73..ac594ad9 100644 --- a/docs/chunked_uploads.md +++ b/docs/chunked_uploads.md @@ -1,5 +1,12 @@ # ChunkedUploadsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/chunked_uploads.md](https://github.com/box/box-python-sdk/blob/main/docs/chunked_uploads.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + This is a manager for chunked uploads (allowed for files at least 20MB). - [Create upload session](#create-upload-session) diff --git a/docs/classifications.md b/docs/classifications.md index dc49bd65..df6bd729 100644 --- a/docs/classifications.md +++ b/docs/classifications.md @@ -1,5 +1,12 @@ # ClassificationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/classifications.md](https://github.com/box/box-python-sdk/blob/main/docs/classifications.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all classifications](#list-all-classifications) - [Add classification](#add-classification) - [Update classification](#update-classification) diff --git a/docs/client.md b/docs/client.md index 48b11a45..ed36b325 100644 --- a/docs/client.md +++ b/docs/client.md @@ -1,5 +1,12 @@ # Client + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/client.md](https://github.com/box/box-python-sdk/blob/main/docs/client.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers. diff --git a/docs/collaboration_allowlist_entries.md b/docs/collaboration_allowlist_entries.md index ff1b297b..095d3e50 100644 --- a/docs/collaboration_allowlist_entries.md +++ b/docs/collaboration_allowlist_entries.md @@ -1,5 +1,12 @@ # CollaborationAllowlistEntriesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/collaboration_allowlist_entries.md](https://github.com/box/box-python-sdk/blob/main/docs/collaboration_allowlist_entries.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List allowed collaboration domains](#list-allowed-collaboration-domains) - [Add domain to list of allowed collaboration domains](#add-domain-to-list-of-allowed-collaboration-domains) - [Get allowed collaboration domain](#get-allowed-collaboration-domain) diff --git a/docs/collaboration_allowlist_exempt_targets.md b/docs/collaboration_allowlist_exempt_targets.md index f5e4077f..a9afe879 100644 --- a/docs/collaboration_allowlist_exempt_targets.md +++ b/docs/collaboration_allowlist_exempt_targets.md @@ -1,5 +1,12 @@ # CollaborationAllowlistExemptTargetsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/collaboration_allowlist_exempt_targets.md](https://github.com/box/box-python-sdk/blob/main/docs/collaboration_allowlist_exempt_targets.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List users exempt from collaboration domain restrictions](#list-users-exempt-from-collaboration-domain-restrictions) - [Create user exemption from collaboration domain restrictions](#create-user-exemption-from-collaboration-domain-restrictions) - [Get user exempt from collaboration domain restrictions](#get-user-exempt-from-collaboration-domain-restrictions) diff --git a/docs/collections.md b/docs/collections.md index 7de23262..5a18a5d1 100644 --- a/docs/collections.md +++ b/docs/collections.md @@ -1,5 +1,12 @@ # CollectionsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/collections.md](https://github.com/box/box-python-sdk/blob/main/docs/collections.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all collections](#list-all-collections) - [List collection items](#list-collection-items) - [Get collection by ID](#get-collection-by-id) diff --git a/docs/comments.md b/docs/comments.md index b5434eee..9529c464 100644 --- a/docs/comments.md +++ b/docs/comments.md @@ -1,5 +1,12 @@ # CommentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/comments.md](https://github.com/box/box-python-sdk/blob/main/docs/comments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List file comments](#list-file-comments) - [Get comment](#get-comment) - [Update comment](#update-comment) diff --git a/docs/configuration.md b/docs/configuration.md index 4c10d7f8..79d28b83 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,5 +1,12 @@ # Configuration + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/configuration.md](https://github.com/box/box-python-sdk/blob/main/docs/configuration.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + diff --git a/docs/device_pinners.md b/docs/device_pinners.md index 77fd4ce4..04e75f1c 100644 --- a/docs/device_pinners.md +++ b/docs/device_pinners.md @@ -1,5 +1,12 @@ # DevicePinnersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/device_pinners.md](https://github.com/box/box-python-sdk/blob/main/docs/device_pinners.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get device pin](#get-device-pin) - [Remove device pin](#remove-device-pin) - [List enterprise device pins](#list-enterprise-device-pins) diff --git a/docs/docgen.md b/docs/docgen.md index 6ba00e60..fadd749c 100644 --- a/docs/docgen.md +++ b/docs/docgen.md @@ -1,5 +1,12 @@ # DocgenManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/docgen.md](https://github.com/box/box-python-sdk/blob/main/docs/docgen.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get Box Doc Gen job by ID](#get-box-doc-gen-job-by-id) - [List all Box Doc Gen jobs](#list-all-box-doc-gen-jobs) - [Get Box Doc Gen jobs by batch ID](#get-box-doc-gen-jobs-by-batch-id) diff --git a/docs/docgen_template.md b/docs/docgen_template.md index e9e979a5..d6337ba6 100644 --- a/docs/docgen_template.md +++ b/docs/docgen_template.md @@ -1,5 +1,12 @@ # DocgenTemplateManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/docgen_template.md](https://github.com/box/box-python-sdk/blob/main/docs/docgen_template.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Create Box Doc Gen template](#create-box-doc-gen-template) - [List Box Doc Gen templates](#list-box-doc-gen-templates) - [Delete Box Doc Gen template](#delete-box-doc-gen-template) diff --git a/docs/downloads.md b/docs/downloads.md index 46ea036e..3295123a 100644 --- a/docs/downloads.md +++ b/docs/downloads.md @@ -1,5 +1,12 @@ # DownloadsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/downloads.md](https://github.com/box/box-python-sdk/blob/main/docs/downloads.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Download file URL](#download-file-url) - [Download file](#download-file) - [Download file](#download-file) diff --git a/docs/email_aliases.md b/docs/email_aliases.md index 538ee43b..b3d8db30 100644 --- a/docs/email_aliases.md +++ b/docs/email_aliases.md @@ -1,5 +1,12 @@ # EmailAliasesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/email_aliases.md](https://github.com/box/box-python-sdk/blob/main/docs/email_aliases.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List user's email aliases](#list-users-email-aliases) - [Create email alias](#create-email-alias) - [Remove email alias](#remove-email-alias) diff --git a/docs/event-stream.md b/docs/event-stream.md index fede611f..eb309f80 100644 --- a/docs/event-stream.md +++ b/docs/event-stream.md @@ -1,5 +1,12 @@ # Event Stream + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/event-stream.md](https://github.com/box/box-python-sdk/blob/main/docs/event-stream.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + The Event Stream class utilizes long-polling to receive real-time events from Box. The SDK provides an easy way to set up and manage the event stream which returns an iterable object and yields events as they are received. diff --git a/docs/events.md b/docs/events.md index 7e4e45cf..e99ef7a1 100644 --- a/docs/events.md +++ b/docs/events.md @@ -1,5 +1,12 @@ # EventsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/events.md](https://github.com/box/box-python-sdk/blob/main/docs/events.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get events long poll endpoint](#get-events-long-poll-endpoint) - [List user and enterprise events](#list-user-and-enterprise-events) - [Get event stream](#get-event-stream) diff --git a/docs/file_classifications.md b/docs/file_classifications.md index 113e50d7..68adee1b 100644 --- a/docs/file_classifications.md +++ b/docs/file_classifications.md @@ -1,5 +1,12 @@ # FileClassificationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_classifications.md](https://github.com/box/box-python-sdk/blob/main/docs/file_classifications.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get classification on file](#get-classification-on-file) - [Add classification to file](#add-classification-to-file) - [Update classification on file](#update-classification-on-file) diff --git a/docs/file_metadata.md b/docs/file_metadata.md index 5f611f00..13c1b24f 100644 --- a/docs/file_metadata.md +++ b/docs/file_metadata.md @@ -1,5 +1,12 @@ # FileMetadataManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_metadata.md](https://github.com/box/box-python-sdk/blob/main/docs/file_metadata.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List metadata instances on file](#list-metadata-instances-on-file) - [Get metadata instance on file](#get-metadata-instance-on-file) - [Create metadata instance on file](#create-metadata-instance-on-file) diff --git a/docs/file_requests.md b/docs/file_requests.md index 3c77125f..50c49aea 100644 --- a/docs/file_requests.md +++ b/docs/file_requests.md @@ -1,5 +1,12 @@ # FileRequestsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_requests.md](https://github.com/box/box-python-sdk/blob/main/docs/file_requests.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get file request](#get-file-request) - [Update file request](#update-file-request) - [Delete file request](#delete-file-request) diff --git a/docs/file_version_legal_holds.md b/docs/file_version_legal_holds.md index 7026d223..a355a7ab 100644 --- a/docs/file_version_legal_holds.md +++ b/docs/file_version_legal_holds.md @@ -1,5 +1,12 @@ # FileVersionLegalHoldsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_version_legal_holds.md](https://github.com/box/box-python-sdk/blob/main/docs/file_version_legal_holds.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get file version legal hold](#get-file-version-legal-hold) - [List file version legal holds](#list-file-version-legal-holds) diff --git a/docs/file_version_retentions.md b/docs/file_version_retentions.md index 890fac99..b98eaaeb 100644 --- a/docs/file_version_retentions.md +++ b/docs/file_version_retentions.md @@ -1,5 +1,12 @@ # FileVersionRetentionsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_version_retentions.md](https://github.com/box/box-python-sdk/blob/main/docs/file_version_retentions.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List file version retentions](#list-file-version-retentions) - [Get retention on file](#get-retention-on-file) diff --git a/docs/file_versions.md b/docs/file_versions.md index dbd919f8..a0b26416 100644 --- a/docs/file_versions.md +++ b/docs/file_versions.md @@ -1,5 +1,12 @@ # FileVersionsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_versions.md](https://github.com/box/box-python-sdk/blob/main/docs/file_versions.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all file versions](#list-all-file-versions) - [Get file version](#get-file-version) - [Remove file version](#remove-file-version) diff --git a/docs/file_watermarks.md b/docs/file_watermarks.md index 3ef0f6d5..2105999a 100644 --- a/docs/file_watermarks.md +++ b/docs/file_watermarks.md @@ -1,5 +1,12 @@ # FileWatermarksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/file_watermarks.md](https://github.com/box/box-python-sdk/blob/main/docs/file_watermarks.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get watermark on file](#get-watermark-on-file) - [Apply watermark to file](#apply-watermark-to-file) - [Remove watermark from file](#remove-watermark-from-file) diff --git a/docs/files.md b/docs/files.md index 9ce0de62..4954fecd 100644 --- a/docs/files.md +++ b/docs/files.md @@ -1,5 +1,12 @@ # FilesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/files.md](https://github.com/box/box-python-sdk/blob/main/docs/files.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get file information](#get-file-information) - [Update file](#update-file) - [Delete file](#delete-file) diff --git a/docs/folder_classifications.md b/docs/folder_classifications.md index a10765c4..feec5a43 100644 --- a/docs/folder_classifications.md +++ b/docs/folder_classifications.md @@ -1,5 +1,12 @@ # FolderClassificationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/folder_classifications.md](https://github.com/box/box-python-sdk/blob/main/docs/folder_classifications.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get classification on folder](#get-classification-on-folder) - [Add classification to folder](#add-classification-to-folder) - [Update classification on folder](#update-classification-on-folder) diff --git a/docs/folder_locks.md b/docs/folder_locks.md index 85fa4661..90411fdb 100644 --- a/docs/folder_locks.md +++ b/docs/folder_locks.md @@ -1,5 +1,12 @@ # FolderLocksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/folder_locks.md](https://github.com/box/box-python-sdk/blob/main/docs/folder_locks.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List folder locks](#list-folder-locks) - [Create folder lock](#create-folder-lock) - [Delete folder lock](#delete-folder-lock) diff --git a/docs/folder_metadata.md b/docs/folder_metadata.md index 0f6b729c..148249a6 100644 --- a/docs/folder_metadata.md +++ b/docs/folder_metadata.md @@ -1,5 +1,12 @@ # FolderMetadataManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/folder_metadata.md](https://github.com/box/box-python-sdk/blob/main/docs/folder_metadata.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List metadata instances on folder](#list-metadata-instances-on-folder) - [Get metadata instance on folder](#get-metadata-instance-on-folder) - [Create metadata instance on folder](#create-metadata-instance-on-folder) diff --git a/docs/folder_watermarks.md b/docs/folder_watermarks.md index dc23285e..9b3dbb03 100644 --- a/docs/folder_watermarks.md +++ b/docs/folder_watermarks.md @@ -1,5 +1,12 @@ # FolderWatermarksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/folder_watermarks.md](https://github.com/box/box-python-sdk/blob/main/docs/folder_watermarks.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get watermark for folder](#get-watermark-for-folder) - [Apply watermark to folder](#apply-watermark-to-folder) - [Remove watermark from folder](#remove-watermark-from-folder) diff --git a/docs/folders.md b/docs/folders.md index fa2d3332..f6898cf7 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -1,5 +1,12 @@ # FoldersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/folders.md](https://github.com/box/box-python-sdk/blob/main/docs/folders.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get folder information](#get-folder-information) - [Update folder](#update-folder) - [Delete folder](#delete-folder) diff --git a/docs/groups.md b/docs/groups.md index 6f1143c3..c8c4cef7 100644 --- a/docs/groups.md +++ b/docs/groups.md @@ -1,5 +1,12 @@ # GroupsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/groups.md](https://github.com/box/box-python-sdk/blob/main/docs/groups.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List groups for enterprise](#list-groups-for-enterprise) - [Create group](#create-group) - [Get group](#get-group) diff --git a/docs/hub_collaborations.md b/docs/hub_collaborations.md index 585e0ba9..a97ec6a2 100644 --- a/docs/hub_collaborations.md +++ b/docs/hub_collaborations.md @@ -1,5 +1,12 @@ # HubCollaborationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/hub_collaborations.md](https://github.com/box/box-python-sdk/blob/main/docs/hub_collaborations.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get Box Hub collaborations](#get-box-hub-collaborations) - [Create Box Hub collaboration](#create-box-hub-collaboration) - [Get Box Hub collaboration by collaboration ID](#get-box-hub-collaboration-by-collaboration-id) diff --git a/docs/hub_items.md b/docs/hub_items.md index 966349d6..1faa8800 100644 --- a/docs/hub_items.md +++ b/docs/hub_items.md @@ -1,5 +1,12 @@ # HubItemsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/hub_items.md](https://github.com/box/box-python-sdk/blob/main/docs/hub_items.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get Box Hub items](#get-box-hub-items) - [Manage Box Hub items](#manage-box-hub-items) diff --git a/docs/hubs.md b/docs/hubs.md index 10b1459b..5f878146 100644 --- a/docs/hubs.md +++ b/docs/hubs.md @@ -1,5 +1,12 @@ # HubsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/hubs.md](https://github.com/box/box-python-sdk/blob/main/docs/hubs.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all Box Hubs](#list-all-box-hubs) - [Create Box Hub](#create-box-hub) - [List all Box Hubs for requesting enterprise](#list-all-box-hubs-for-requesting-enterprise) diff --git a/docs/integration_mappings.md b/docs/integration_mappings.md index 1b48ead7..cad6fe75 100644 --- a/docs/integration_mappings.md +++ b/docs/integration_mappings.md @@ -1,5 +1,12 @@ # IntegrationMappingsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/integration_mappings.md](https://github.com/box/box-python-sdk/blob/main/docs/integration_mappings.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List Slack integration mappings](#list-slack-integration-mappings) - [Create Slack integration mapping](#create-slack-integration-mapping) - [Update Slack integration mapping](#update-slack-integration-mapping) diff --git a/docs/invites.md b/docs/invites.md index 5cfa0048..deb244e1 100644 --- a/docs/invites.md +++ b/docs/invites.md @@ -1,5 +1,12 @@ # InvitesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/invites.md](https://github.com/box/box-python-sdk/blob/main/docs/invites.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Create user invite](#create-user-invite) - [Get user invite status](#get-user-invite-status) diff --git a/docs/legal_hold_policies.md b/docs/legal_hold_policies.md index 361ab5b3..12a5169b 100644 --- a/docs/legal_hold_policies.md +++ b/docs/legal_hold_policies.md @@ -1,5 +1,12 @@ # LegalHoldPoliciesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/legal_hold_policies.md](https://github.com/box/box-python-sdk/blob/main/docs/legal_hold_policies.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all legal hold policies](#list-all-legal-hold-policies) - [Create legal hold policy](#create-legal-hold-policy) - [Get legal hold policy](#get-legal-hold-policy) diff --git a/docs/legal_hold_policy_assignments.md b/docs/legal_hold_policy_assignments.md index cd14c2ae..e3e11fd4 100644 --- a/docs/legal_hold_policy_assignments.md +++ b/docs/legal_hold_policy_assignments.md @@ -1,5 +1,12 @@ # LegalHoldPolicyAssignmentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/legal_hold_policy_assignments.md](https://github.com/box/box-python-sdk/blob/main/docs/legal_hold_policy_assignments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List legal hold policy assignments](#list-legal-hold-policy-assignments) - [Assign legal hold policy](#assign-legal-hold-policy) - [Get legal hold policy assignment](#get-legal-hold-policy-assignment) diff --git a/docs/list_collaborations.md b/docs/list_collaborations.md index e2722795..11074016 100644 --- a/docs/list_collaborations.md +++ b/docs/list_collaborations.md @@ -1,5 +1,12 @@ # ListCollaborationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/list_collaborations.md](https://github.com/box/box-python-sdk/blob/main/docs/list_collaborations.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List file collaborations](#list-file-collaborations) - [List folder collaborations](#list-folder-collaborations) - [List pending collaborations](#list-pending-collaborations) diff --git a/docs/memberships.md b/docs/memberships.md index 2bb9c8ea..ac2aa3e0 100644 --- a/docs/memberships.md +++ b/docs/memberships.md @@ -1,5 +1,12 @@ # MembershipsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/memberships.md](https://github.com/box/box-python-sdk/blob/main/docs/memberships.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List user's groups](#list-users-groups) - [List members of group](#list-members-of-group) - [Add user to group](#add-user-to-group) diff --git a/docs/metadata_cascade_policies.md b/docs/metadata_cascade_policies.md index 0f7604fe..1a49fed4 100644 --- a/docs/metadata_cascade_policies.md +++ b/docs/metadata_cascade_policies.md @@ -1,5 +1,12 @@ # MetadataCascadePoliciesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/metadata_cascade_policies.md](https://github.com/box/box-python-sdk/blob/main/docs/metadata_cascade_policies.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List metadata cascade policies](#list-metadata-cascade-policies) - [Create metadata cascade policy](#create-metadata-cascade-policy) - [Get metadata cascade policy](#get-metadata-cascade-policy) diff --git a/docs/metadata_templates.md b/docs/metadata_templates.md index 56b848c4..f02b4298 100644 --- a/docs/metadata_templates.md +++ b/docs/metadata_templates.md @@ -1,5 +1,12 @@ # MetadataTemplatesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/metadata_templates.md](https://github.com/box/box-python-sdk/blob/main/docs/metadata_templates.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Find metadata template by instance ID](#find-metadata-template-by-instance-id) - [Get metadata template by name](#get-metadata-template-by-name) - [Update metadata template](#update-metadata-template) diff --git a/docs/recent_items.md b/docs/recent_items.md index 4f1c8656..8653d6ad 100644 --- a/docs/recent_items.md +++ b/docs/recent_items.md @@ -1,5 +1,12 @@ # RecentItemsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/recent_items.md](https://github.com/box/box-python-sdk/blob/main/docs/recent_items.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List recently accessed items](#list-recently-accessed-items) ## List recently accessed items diff --git a/docs/retention_policies.md b/docs/retention_policies.md index d92ba85b..e3df4679 100644 --- a/docs/retention_policies.md +++ b/docs/retention_policies.md @@ -1,5 +1,12 @@ # RetentionPoliciesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/retention_policies.md](https://github.com/box/box-python-sdk/blob/main/docs/retention_policies.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List retention policies](#list-retention-policies) - [Create retention policy](#create-retention-policy) - [Get retention policy](#get-retention-policy) diff --git a/docs/retention_policy_assignments.md b/docs/retention_policy_assignments.md index d1249371..93defe02 100644 --- a/docs/retention_policy_assignments.md +++ b/docs/retention_policy_assignments.md @@ -1,5 +1,12 @@ # RetentionPolicyAssignmentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/retention_policy_assignments.md](https://github.com/box/box-python-sdk/blob/main/docs/retention_policy_assignments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List retention policy assignments](#list-retention-policy-assignments) - [Assign retention policy](#assign-retention-policy) - [Get retention policy assignment](#get-retention-policy-assignment) diff --git a/docs/search.md b/docs/search.md index 580dcab9..c3a5e890 100644 --- a/docs/search.md +++ b/docs/search.md @@ -1,5 +1,12 @@ # SearchManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/search.md](https://github.com/box/box-python-sdk/blob/main/docs/search.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Query files/folders by metadata](#query-files-folders-by-metadata) - [Search for content](#search-for-content) diff --git a/docs/session_termination.md b/docs/session_termination.md index 5e05aed0..f53e6768 100644 --- a/docs/session_termination.md +++ b/docs/session_termination.md @@ -1,5 +1,12 @@ # SessionTerminationManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/session_termination.md](https://github.com/box/box-python-sdk/blob/main/docs/session_termination.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Create jobs to terminate users session](#create-jobs-to-terminate-users-session) - [Create jobs to terminate user group session](#create-jobs-to-terminate-user-group-session) diff --git a/docs/shared_links_app_items.md b/docs/shared_links_app_items.md index 740ab9ad..c9f0c1f3 100644 --- a/docs/shared_links_app_items.md +++ b/docs/shared_links_app_items.md @@ -1,5 +1,12 @@ # SharedLinksAppItemsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shared_links_app_items.md](https://github.com/box/box-python-sdk/blob/main/docs/shared_links_app_items.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Find app item for shared link](#find-app-item-for-shared-link) ## Find app item for shared link diff --git a/docs/shared_links_files.md b/docs/shared_links_files.md index 4d9bb23f..dd465e70 100644 --- a/docs/shared_links_files.md +++ b/docs/shared_links_files.md @@ -1,5 +1,12 @@ # SharedLinksFilesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shared_links_files.md](https://github.com/box/box-python-sdk/blob/main/docs/shared_links_files.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Find file for shared link](#find-file-for-shared-link) - [Get shared link for file](#get-shared-link-for-file) - [Add shared link to file](#add-shared-link-to-file) diff --git a/docs/shared_links_folders.md b/docs/shared_links_folders.md index 48779321..75beea26 100644 --- a/docs/shared_links_folders.md +++ b/docs/shared_links_folders.md @@ -1,5 +1,12 @@ # SharedLinksFoldersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shared_links_folders.md](https://github.com/box/box-python-sdk/blob/main/docs/shared_links_folders.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Find folder for shared link](#find-folder-for-shared-link) - [Get shared link for folder](#get-shared-link-for-folder) - [Add shared link to folder](#add-shared-link-to-folder) diff --git a/docs/shared_links_web_links.md b/docs/shared_links_web_links.md index e9d58dce..4bea5aaf 100644 --- a/docs/shared_links_web_links.md +++ b/docs/shared_links_web_links.md @@ -1,5 +1,12 @@ # SharedLinksWebLinksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shared_links_web_links.md](https://github.com/box/box-python-sdk/blob/main/docs/shared_links_web_links.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Find web link for shared link](#find-web-link-for-shared-link) - [Get shared link for web link](#get-shared-link-for-web-link) - [Add shared link to web link](#add-shared-link-to-web-link) diff --git a/docs/shield_information_barrier_reports.md b/docs/shield_information_barrier_reports.md index f9b7990e..e47cfa5e 100644 --- a/docs/shield_information_barrier_reports.md +++ b/docs/shield_information_barrier_reports.md @@ -1,5 +1,12 @@ # ShieldInformationBarrierReportsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_information_barrier_reports.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_information_barrier_reports.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List shield information barrier reports](#list-shield-information-barrier-reports) - [Create shield information barrier report](#create-shield-information-barrier-report) - [Get shield information barrier report by ID](#get-shield-information-barrier-report-by-id) diff --git a/docs/shield_information_barrier_segment_members.md b/docs/shield_information_barrier_segment_members.md index 13fa7510..4e181c70 100644 --- a/docs/shield_information_barrier_segment_members.md +++ b/docs/shield_information_barrier_segment_members.md @@ -1,5 +1,12 @@ # ShieldInformationBarrierSegmentMembersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_information_barrier_segment_members.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_information_barrier_segment_members.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get shield information barrier segment member by ID](#get-shield-information-barrier-segment-member-by-id) - [Delete shield information barrier segment member by ID](#delete-shield-information-barrier-segment-member-by-id) - [List shield information barrier segment members](#list-shield-information-barrier-segment-members) diff --git a/docs/shield_information_barrier_segment_restrictions.md b/docs/shield_information_barrier_segment_restrictions.md index d18dbbe5..3b0ef5d9 100644 --- a/docs/shield_information_barrier_segment_restrictions.md +++ b/docs/shield_information_barrier_segment_restrictions.md @@ -1,5 +1,12 @@ # ShieldInformationBarrierSegmentRestrictionsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_information_barrier_segment_restrictions.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_information_barrier_segment_restrictions.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get shield information barrier segment restriction by ID](#get-shield-information-barrier-segment-restriction-by-id) - [Delete shield information barrier segment restriction by ID](#delete-shield-information-barrier-segment-restriction-by-id) - [List shield information barrier segment restrictions](#list-shield-information-barrier-segment-restrictions) diff --git a/docs/shield_information_barrier_segments.md b/docs/shield_information_barrier_segments.md index c208101e..c493b76a 100644 --- a/docs/shield_information_barrier_segments.md +++ b/docs/shield_information_barrier_segments.md @@ -1,5 +1,12 @@ # ShieldInformationBarrierSegmentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_information_barrier_segments.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_information_barrier_segments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get shield information barrier segment with specified ID](#get-shield-information-barrier-segment-with-specified-id) - [Delete shield information barrier segment](#delete-shield-information-barrier-segment) - [Update shield information barrier segment with specified ID](#update-shield-information-barrier-segment-with-specified-id) diff --git a/docs/shield_information_barriers.md b/docs/shield_information_barriers.md index 50b3efce..2e5c8dae 100644 --- a/docs/shield_information_barriers.md +++ b/docs/shield_information_barriers.md @@ -1,5 +1,12 @@ # ShieldInformationBarriersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_information_barriers.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_information_barriers.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get shield information barrier with specified ID](#get-shield-information-barrier-with-specified-id) - [Add changed status of shield information barrier with specified ID](#add-changed-status-of-shield-information-barrier-with-specified-id) - [List shield information barriers](#list-shield-information-barriers) diff --git a/docs/shield_lists.md b/docs/shield_lists.md index 39505cad..9da1a7fd 100644 --- a/docs/shield_lists.md +++ b/docs/shield_lists.md @@ -1,5 +1,12 @@ # ShieldListsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/shield_lists.md](https://github.com/box/box-python-sdk/blob/main/docs/shield_lists.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get all shield lists in enterprise](#get-all-shield-lists-in-enterprise) - [Create shield list](#create-shield-list) - [Get single shield list by shield list id](#get-single-shield-list-by-shield-list-id) diff --git a/docs/sign_requests.md b/docs/sign_requests.md index bee34665..39905464 100644 --- a/docs/sign_requests.md +++ b/docs/sign_requests.md @@ -1,5 +1,12 @@ # SignRequestsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/sign_requests.md](https://github.com/box/box-python-sdk/blob/main/docs/sign_requests.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Cancel Box Sign request](#cancel-box-sign-request) - [Resend Box Sign request](#resend-box-sign-request) - [Get Box Sign request by ID](#get-box-sign-request-by-id) diff --git a/docs/sign_templates.md b/docs/sign_templates.md index c9c6bfa1..9ac8dc5d 100644 --- a/docs/sign_templates.md +++ b/docs/sign_templates.md @@ -1,5 +1,12 @@ # SignTemplatesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/sign_templates.md](https://github.com/box/box-python-sdk/blob/main/docs/sign_templates.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List Box Sign templates](#list-box-sign-templates) - [Get Box Sign template by ID](#get-box-sign-template-by-id) diff --git a/docs/skills.md b/docs/skills.md index 1c15dbe9..f89a56ca 100644 --- a/docs/skills.md +++ b/docs/skills.md @@ -1,5 +1,12 @@ # SkillsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/skills.md](https://github.com/box/box-python-sdk/blob/main/docs/skills.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List Box Skill cards on file](#list-box-skill-cards-on-file) - [Create Box Skill cards on file](#create-box-skill-cards-on-file) - [Update Box Skill cards on file](#update-box-skill-cards-on-file) diff --git a/docs/storage_policies.md b/docs/storage_policies.md index f28f7d1b..9aa8debd 100644 --- a/docs/storage_policies.md +++ b/docs/storage_policies.md @@ -1,5 +1,12 @@ # StoragePoliciesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/storage_policies.md](https://github.com/box/box-python-sdk/blob/main/docs/storage_policies.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List storage policies](#list-storage-policies) - [Get storage policy](#get-storage-policy) diff --git a/docs/storage_policy_assignments.md b/docs/storage_policy_assignments.md index 187dd3c5..1379ff3e 100644 --- a/docs/storage_policy_assignments.md +++ b/docs/storage_policy_assignments.md @@ -1,5 +1,12 @@ # StoragePolicyAssignmentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/storage_policy_assignments.md](https://github.com/box/box-python-sdk/blob/main/docs/storage_policy_assignments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List storage policy assignments](#list-storage-policy-assignments) - [Assign storage policy](#assign-storage-policy) - [Get storage policy assignment](#get-storage-policy-assignment) diff --git a/docs/task_assignments.md b/docs/task_assignments.md index c0fcbefb..4438f378 100644 --- a/docs/task_assignments.md +++ b/docs/task_assignments.md @@ -1,5 +1,12 @@ # TaskAssignmentsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/task_assignments.md](https://github.com/box/box-python-sdk/blob/main/docs/task_assignments.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List task assignments](#list-task-assignments) - [Assign task](#assign-task) - [Get task assignment](#get-task-assignment) diff --git a/docs/tasks.md b/docs/tasks.md index 75548796..9b41a9b2 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -1,5 +1,12 @@ # TasksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/tasks.md](https://github.com/box/box-python-sdk/blob/main/docs/tasks.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List tasks on file](#list-tasks-on-file) - [Create task](#create-task) - [Get task](#get-task) diff --git a/docs/terms_of_service_user_statuses.md b/docs/terms_of_service_user_statuses.md index 24c9e9e5..fba56a9f 100644 --- a/docs/terms_of_service_user_statuses.md +++ b/docs/terms_of_service_user_statuses.md @@ -1,5 +1,12 @@ # TermsOfServiceUserStatusesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/terms_of_service_user_statuses.md](https://github.com/box/box-python-sdk/blob/main/docs/terms_of_service_user_statuses.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List terms of service user statuses](#list-terms-of-service-user-statuses) - [Create terms of service status for new user](#create-terms-of-service-status-for-new-user) - [Update terms of service status for existing user](#update-terms-of-service-status-for-existing-user) diff --git a/docs/terms_of_services.md b/docs/terms_of_services.md index 68be1961..d18a41d9 100644 --- a/docs/terms_of_services.md +++ b/docs/terms_of_services.md @@ -1,5 +1,12 @@ # TermsOfServicesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/terms_of_services.md](https://github.com/box/box-python-sdk/blob/main/docs/terms_of_services.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List terms of services](#list-terms-of-services) - [Create terms of service](#create-terms-of-service) - [Get terms of service](#get-terms-of-service) diff --git a/docs/transfer.md b/docs/transfer.md index d3e6b3c5..eafe0abc 100644 --- a/docs/transfer.md +++ b/docs/transfer.md @@ -1,5 +1,12 @@ # TransferManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/transfer.md](https://github.com/box/box-python-sdk/blob/main/docs/transfer.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Transfer owned folders](#transfer-owned-folders) ## Transfer owned folders diff --git a/docs/trashed_files.md b/docs/trashed_files.md index 3b77196f..e5d425a3 100644 --- a/docs/trashed_files.md +++ b/docs/trashed_files.md @@ -1,5 +1,12 @@ # TrashedFilesManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/trashed_files.md](https://github.com/box/box-python-sdk/blob/main/docs/trashed_files.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Restore file](#restore-file) - [Get trashed file](#get-trashed-file) - [Permanently remove file](#permanently-remove-file) diff --git a/docs/trashed_folders.md b/docs/trashed_folders.md index 66a0f27f..61fe2a8c 100644 --- a/docs/trashed_folders.md +++ b/docs/trashed_folders.md @@ -1,5 +1,12 @@ # TrashedFoldersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/trashed_folders.md](https://github.com/box/box-python-sdk/blob/main/docs/trashed_folders.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Restore folder](#restore-folder) - [Get trashed folder](#get-trashed-folder) - [Permanently remove folder](#permanently-remove-folder) diff --git a/docs/trashed_items.md b/docs/trashed_items.md index 22b41a27..2d2bb94f 100644 --- a/docs/trashed_items.md +++ b/docs/trashed_items.md @@ -1,5 +1,12 @@ # TrashedItemsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/trashed_items.md](https://github.com/box/box-python-sdk/blob/main/docs/trashed_items.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List trashed items](#list-trashed-items) ## List trashed items diff --git a/docs/trashed_web_links.md b/docs/trashed_web_links.md index b1d31d08..23888a96 100644 --- a/docs/trashed_web_links.md +++ b/docs/trashed_web_links.md @@ -1,5 +1,12 @@ # TrashedWebLinksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/trashed_web_links.md](https://github.com/box/box-python-sdk/blob/main/docs/trashed_web_links.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Restore web link](#restore-web-link) - [Get trashed web link](#get-trashed-web-link) - [Permanently remove web link](#permanently-remove-web-link) diff --git a/docs/uploads.md b/docs/uploads.md index 8d409530..70e522d2 100644 --- a/docs/uploads.md +++ b/docs/uploads.md @@ -1,5 +1,12 @@ # UploadsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/uploads.md](https://github.com/box/box-python-sdk/blob/main/docs/uploads.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Upload file version](#upload-file-version) - [Preflight check before upload](#preflight-check-before-upload) - [Upload file](#upload-file) diff --git a/docs/user_collaborations.md b/docs/user_collaborations.md index 48086013..0855abcb 100644 --- a/docs/user_collaborations.md +++ b/docs/user_collaborations.md @@ -1,5 +1,12 @@ # UserCollaborationsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/user_collaborations.md](https://github.com/box/box-python-sdk/blob/main/docs/user_collaborations.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Get collaboration](#get-collaboration) - [Update collaboration](#update-collaboration) - [Remove collaboration](#remove-collaboration) diff --git a/docs/users.md b/docs/users.md index 63a8191d..f44f329e 100644 --- a/docs/users.md +++ b/docs/users.md @@ -1,5 +1,12 @@ # UsersManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/users.md](https://github.com/box/box-python-sdk/blob/main/docs/users.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List enterprise users](#list-enterprise-users) - [Create user](#create-user) - [Get current user](#get-current-user) diff --git a/docs/web_links.md b/docs/web_links.md index 1700761f..1ce7ad4a 100644 --- a/docs/web_links.md +++ b/docs/web_links.md @@ -1,5 +1,12 @@ # WebLinksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/web_links.md](https://github.com/box/box-python-sdk/blob/main/docs/web_links.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Create web link](#create-web-link) - [Get web link](#get-web-link) - [Update web link](#update-web-link) diff --git a/docs/webhooks.md b/docs/webhooks.md index 810cd0a2..1fc84e21 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -1,5 +1,12 @@ # WebhooksManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/webhooks.md](https://github.com/box/box-python-sdk/blob/main/docs/webhooks.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List all webhooks](#list-all-webhooks) - [Create webhook](#create-webhook) - [Get webhook](#get-webhook) diff --git a/docs/workflows.md b/docs/workflows.md index e218ea94..86d4442b 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -1,5 +1,12 @@ # WorkflowsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/workflows.md](https://github.com/box/box-python-sdk/blob/main/docs/workflows.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [List workflows](#list-workflows) - [Starts workflow based on request body](#starts-workflow-based-on-request-body) diff --git a/docs/working-with-nulls.md b/docs/working-with-nulls.md index 8ebc3d10..f5a9bb3b 100644 --- a/docs/working-with-nulls.md +++ b/docs/working-with-nulls.md @@ -1,5 +1,12 @@ # Handling null values in Box Python SDK Gen + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/working-with-nulls.md](https://github.com/box/box-python-sdk/blob/main/docs/working-with-nulls.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + While using Box Python SDK it's important to understand how null values behave. This document provides a general overview of null value behaviour in Box Python SDK to help developers manage data consistently and predictably. ## Understanding null behaviour diff --git a/docs/zip_downloads.md b/docs/zip_downloads.md index 2a4b8fc5..73db9a97 100644 --- a/docs/zip_downloads.md +++ b/docs/zip_downloads.md @@ -1,5 +1,12 @@ # ZipDownloadsManager + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [box-python-sdk/docs/zip_downloads.md](https://github.com/box/box-python-sdk/blob/main/docs/zip_downloads.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + - [Create zip download](#create-zip-download) - [Download zip archive](#download-zip-archive) - [Get zip download status](#get-zip-download-status) diff --git a/migration-guide.md b/migration-guide.md index 41bacb6f..fed81fa6 100644 --- a/migration-guide.md +++ b/migration-guide.md @@ -1,5 +1,12 @@ # Migration guide from `boxsdk` to `box-sdk-gen` + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. +> The equivalent of this page is [the box-python-sdk-gen to box-python-sdk migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + From 891c7c70f3b955d4828fb39f1575b4c98297ad43 Mon Sep 17 00:00:00 2001 From: Tsitsi Nyamutswa <128546813+tnyamutswa@users.noreply.github.com> Date: Thu, 5 Nov 2026 14:59:36 +0100 Subject: [PATCH 2/2] docs: add api.md listing every manager and method --- README.md | 6 +- api.md | 899 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/README.md | 2 + 3 files changed, 906 insertions(+), 1 deletion(-) create mode 100644 api.md diff --git a/README.md b/README.md index 5f2a6deb..28c6905f 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,8 @@ pip install "box-sdk-gen[jwt]" # Getting Started +The full API of this library is listed in [api.md](api.md), with code samples for each manager in [docs/](docs/README.md). + To get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer Console](https://app.box.com/developers/console). You can use this token to make test calls for your own Box account. @@ -95,7 +97,9 @@ if __name__ == '__main__': # Documentation -Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information. +- [api.md](api.md): every manager and method on `BoxClient`, with signatures and return types. +- [docs/](docs/README.md): code samples for each manager, plus guides for [authentication](docs/authentication.md), [configuration](docs/configuration.md), and [the client](docs/client.md). +- [Box API Reference](https://developer.box.com/reference/): the underlying REST API. For `box-python-sdk`, the maintained replacement for this package, see its [README](https://github.com/box/box-python-sdk/blob/main/README.md) and [docs](https://github.com/box/box-python-sdk/blob/main/docs/README.md). diff --git a/api.md b/api.md new file mode 100644 index 00000000..f966e2f1 --- /dev/null +++ b/api.md @@ -0,0 +1,899 @@ +# API Reference + +> [!CAUTION] +> **`box-python-sdk-gen` is deprecated and no longer maintained.** As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects. +> +> Use [`box-python-sdk`](https://github.com/box/box-python-sdk) v10+ instead: `pip install "boxsdk>=10"`. `box-python-sdk` v10 includes every manager listed below, plus newer ones. +> To migrate existing code, see the [migration guide](https://github.com/box/box-python-sdk/blob/main/migration-guides/from-box-python-sdk-gen-v1-to-box-python-sdk.md). + +This file lists every manager and method exposed on `BoxClient`. For setup, authentication, and usage examples, see [README.md](README.md). Each section links to a page in [docs/](docs/README.md) with code samples. Parameters marked `?` are optional. + +# Client + +See [docs/client.md](docs/client.md) and [docs/configuration.md](docs/configuration.md). + +Methods: + +- client.make_request(fetch_options) -> FetchResponse +- client.with_as_user_header(user_id) -> BoxClient +- client.with_suppressed_notifications() -> BoxClient +- client.with_extra_headers(extra_headers?) -> BoxClient +- client.with_custom_base_urls(base_urls) -> BoxClient +- client.with_proxy(config) -> BoxClient + +# Authorization + +Examples: [docs/authorization.md](docs/authorization.md) + +Methods: + +- client.authorization.authorize_user(response_type, client_id, redirect_uri?, state?, scope?, extra_headers?) -> None +- client.authorization.request_access_token(grant_type, client_id?, client_secret?, code?, refresh_token?, assertion?, subject_token?, subject_token_type?, actor_token?, actor_token_type?, scope?, resource?, box_subject_type?, box_subject_id?, box_shared_link?, extra_headers?) -> AccessToken +- client.authorization.refresh_access_token(client_id, client_secret, refresh_token, grant_type?, extra_headers?) -> AccessToken +- client.authorization.revoke_access_token(client_id?, client_secret?, token?, extra_headers?) -> None + +# Files + +Examples: [docs/files.md](docs/files.md) + +Methods: + +- client.files.get_file_by_id(file_id, fields?, if_none_match?, boxapi?, x_rep_hints?, extra_headers?) -> FileFull +- client.files.update_file_by_id(file_id, name?, description?, parent?, shared_link?, lock?, disposition_at?, permissions?, collections?, tags?, fields?, if_match?, extra_headers?) -> FileFull +- client.files.delete_file_by_id(file_id, if_match?, extra_headers?) -> None +- client.files.copy_file(file_id, parent, name?, version?, fields?, extra_headers?) -> FileFull +- client.files.get_file_thumbnail_url(file_id, extension, min_height?, min_width?, max_height?, max_width?, extra_headers?) -> str +- client.files.get_file_thumbnail_by_id(file_id, extension, min_height?, min_width?, max_height?, max_width?, extra_headers?) -> Optional[ByteStream] + +# Trashed files + +Examples: [docs/trashed_files.md](docs/trashed_files.md) + +Methods: + +- client.trashed_files.restore_file_from_trash(file_id, name?, parent?, fields?, extra_headers?) -> TrashFileRestored +- client.trashed_files.get_trashed_file_by_id(file_id, fields?, extra_headers?) -> TrashFile +- client.trashed_files.delete_trashed_file_by_id(file_id, extra_headers?) -> None + +# App item associations + +Examples: [docs/app_item_associations.md](docs/app_item_associations.md) + +Methods: + +- client.app_item_associations.get_file_app_item_associations(file_id, limit?, marker?, application_type?, extra_headers?) -> AppItemAssociations +- client.app_item_associations.get_folder_app_item_associations(folder_id, limit?, marker?, application_type?, extra_headers?) -> AppItemAssociations + +# Downloads + +Examples: [docs/downloads.md](docs/downloads.md) + +Methods: + +- client.downloads.get_download_file_url(file_id, version?, access_token?, range?, boxapi?, extra_headers?) -> str +- client.downloads.download_file(file_id, version?, access_token?, range?, boxapi?, extra_headers?) -> Optional[ByteStream] +- client.downloads.download_file_to_output_stream(file_id, output_stream, version?, access_token?, range?, boxapi?, extra_headers?) -> None + +# Uploads + +Examples: [docs/uploads.md](docs/uploads.md) + +Methods: + +- client.uploads.upload_file_version(file_id, attributes, file, file_file_name?, file_content_type?, fields?, if_match?, content_md_5?, extra_headers?) -> Files +- client.uploads.preflight_file_upload_check(name?, size?, parent?, extra_headers?) -> UploadUrl +- client.uploads.upload_file(attributes, file, file_file_name?, file_content_type?, fields?, content_md_5?, extra_headers?) -> Files +- client.uploads.upload_with_preflight_check(attributes, file, file_file_name?, file_content_type?, fields?, content_md_5?, extra_headers?) -> Files + +# Chunked uploads + +Examples: [docs/chunked_uploads.md](docs/chunked_uploads.md) + +Methods: + +- client.chunked_uploads.create_file_upload_session(folder_id, file_size, file_name, extra_headers?) -> UploadSession +- client.chunked_uploads.create_file_upload_session_for_existing_file(file_id, file_size, file_name?, extra_headers?) -> UploadSession +- client.chunked_uploads.get_file_upload_session_by_url(url, extra_headers?) -> UploadSession +- client.chunked_uploads.get_file_upload_session_by_id(upload_session_id, extra_headers?) -> UploadSession +- client.chunked_uploads.upload_file_part_by_url(url, request_body, digest, content_range, extra_headers?) -> UploadedPart +- client.chunked_uploads.upload_file_part(upload_session_id, request_body, digest, content_range, extra_headers?) -> UploadedPart +- client.chunked_uploads.delete_file_upload_session_by_url(url, extra_headers?) -> None +- client.chunked_uploads.delete_file_upload_session_by_id(upload_session_id, extra_headers?) -> None +- client.chunked_uploads.get_file_upload_session_parts_by_url(url, offset?, limit?, extra_headers?) -> UploadParts +- client.chunked_uploads.get_file_upload_session_parts(upload_session_id, offset?, limit?, extra_headers?) -> UploadParts +- client.chunked_uploads.create_file_upload_session_commit_by_url(url, parts, digest, if_match?, if_none_match?, extra_headers?) -> Optional[Files] +- client.chunked_uploads.create_file_upload_session_commit(upload_session_id, parts, digest, if_match?, if_none_match?, extra_headers?) -> Optional[Files] +- client.chunked_uploads.upload_big_file(file, file_name, file_size, parent_folder_id) -> FileFull + +# List collaborations + +Examples: [docs/list_collaborations.md](docs/list_collaborations.md) + +Methods: + +- client.list_collaborations.get_file_collaborations(file_id, fields?, limit?, marker?, extra_headers?) -> Collaborations +- client.list_collaborations.get_folder_collaborations(folder_id, fields?, limit?, marker?, extra_headers?) -> Collaborations +- client.list_collaborations.get_collaborations(status, fields?, offset?, limit?, extra_headers?) -> CollaborationsOffsetPaginated +- client.list_collaborations.get_group_collaborations(group_id, limit?, offset?, extra_headers?) -> CollaborationsOffsetPaginated + +# Comments + +Examples: [docs/comments.md](docs/comments.md) + +Methods: + +- client.comments.get_file_comments(file_id, fields?, limit?, offset?, extra_headers?) -> Comments +- client.comments.get_comment_by_id(comment_id, fields?, extra_headers?) -> CommentFull +- client.comments.update_comment_by_id(comment_id, message?, fields?, extra_headers?) -> CommentFull +- client.comments.delete_comment_by_id(comment_id, extra_headers?) -> None +- client.comments.create_comment(message, item, tagged_message?, fields?, extra_headers?) -> CommentFull + +# Tasks + +Examples: [docs/tasks.md](docs/tasks.md) + +Methods: + +- client.tasks.get_file_tasks(file_id, extra_headers?) -> Tasks +- client.tasks.create_task(item, action?, message?, due_at?, completion_rule?, extra_headers?) -> Task +- client.tasks.get_task_by_id(task_id, extra_headers?) -> Task +- client.tasks.update_task_by_id(task_id, action?, message?, due_at?, completion_rule?, extra_headers?) -> Task +- client.tasks.delete_task_by_id(task_id, extra_headers?) -> None + +# File versions + +Examples: [docs/file_versions.md](docs/file_versions.md) + +Methods: + +- client.file_versions.get_file_versions(file_id, fields?, limit?, offset?, extra_headers?) -> FileVersions +- client.file_versions.get_file_version_by_id(file_id, file_version_id, fields?, extra_headers?) -> FileVersionFull +- client.file_versions.delete_file_version_by_id(file_id, file_version_id, if_match?, extra_headers?) -> None +- client.file_versions.update_file_version_by_id(file_id, file_version_id, trashed_at?, extra_headers?) -> FileVersionFull +- client.file_versions.promote_file_version(file_id, id?, type?, fields?, extra_headers?) -> FileVersionFull + +# File metadata + +Examples: [docs/file_metadata.md](docs/file_metadata.md) + +Methods: + +- client.file_metadata.get_file_metadata(file_id, extra_headers?) -> Metadatas +- client.file_metadata.get_file_metadata_by_id(file_id, scope, template_key, extra_headers?) -> MetadataFull +- client.file_metadata.create_file_metadata_by_id(file_id, scope, template_key, request_body, extra_headers?) -> MetadataFull +- client.file_metadata.update_file_metadata_by_id(file_id, scope, template_key, request_body, extra_headers?) -> MetadataFull +- client.file_metadata.delete_file_metadata_by_id(file_id, scope, template_key, extra_headers?) -> None + +# File classifications + +Examples: [docs/file_classifications.md](docs/file_classifications.md) + +Methods: + +- client.file_classifications.get_classification_on_file(file_id, extra_headers?) -> Classification +- client.file_classifications.add_classification_to_file(file_id, box_security_classification_key?, extra_headers?) -> Classification +- client.file_classifications.update_classification_on_file(file_id, request_body, extra_headers?) -> Classification +- client.file_classifications.delete_classification_from_file(file_id, extra_headers?) -> None + +# Skills + +Examples: [docs/skills.md](docs/skills.md) + +Methods: + +- client.skills.get_box_skill_cards_on_file(file_id, extra_headers?) -> SkillCardsMetadata +- client.skills.create_box_skill_cards_on_file(file_id, cards, extra_headers?) -> SkillCardsMetadata +- client.skills.update_box_skill_cards_on_file(file_id, request_body, extra_headers?) -> SkillCardsMetadata +- client.skills.delete_box_skill_cards_from_file(file_id, extra_headers?) -> None +- client.skills.update_all_skill_cards_on_file(skill_id, status, metadata, file, file_version?, usage?, extra_headers?) -> None + +# File watermarks + +Examples: [docs/file_watermarks.md](docs/file_watermarks.md) + +Methods: + +- client.file_watermarks.get_file_watermark(file_id, extra_headers?) -> Watermark +- client.file_watermarks.update_file_watermark(file_id, watermark, extra_headers?) -> Watermark +- client.file_watermarks.delete_file_watermark(file_id, extra_headers?) -> None + +# File requests + +Examples: [docs/file_requests.md](docs/file_requests.md) + +Methods: + +- client.file_requests.get_file_request_by_id(file_request_id, extra_headers?) -> FileRequest +- client.file_requests.update_file_request_by_id(file_request_id, title?, description?, status?, is_email_required?, is_description_required?, expires_at?, if_match?, extra_headers?) -> FileRequest +- client.file_requests.delete_file_request_by_id(file_request_id, extra_headers?) -> None +- client.file_requests.create_file_request_copy(file_request_id, folder, title?, description?, status?, is_email_required?, is_description_required?, expires_at?, extra_headers?) -> FileRequest + +# Folders + +Examples: [docs/folders.md](docs/folders.md) + +Methods: + +- client.folders.get_folder_by_id(folder_id, fields?, sort?, direction?, offset?, limit?, if_none_match?, boxapi?, extra_headers?) -> FolderFull +- client.folders.update_folder_by_id(folder_id, name?, description?, sync_state?, can_non_owners_invite?, parent?, shared_link?, folder_upload_email?, tags?, is_collaboration_restricted_to_enterprise?, collections?, can_non_owners_view_collaborators?, fields?, if_match?, extra_headers?) -> FolderFull +- client.folders.delete_folder_by_id(folder_id, recursive?, if_match?, extra_headers?) -> None +- client.folders.get_folder_items(folder_id, fields?, usemarker?, marker?, offset?, limit?, sort?, direction?, boxapi?, extra_headers?) -> Items +- client.folders.create_folder(name, parent, folder_upload_email?, sync_state?, fields?, extra_headers?) -> FolderFull +- client.folders.copy_folder(folder_id, parent, name?, fields?, extra_headers?) -> FolderFull + +# Trashed folders + +Examples: [docs/trashed_folders.md](docs/trashed_folders.md) + +Methods: + +- client.trashed_folders.restore_folder_from_trash(folder_id, name?, parent?, fields?, extra_headers?) -> TrashFolderRestored +- client.trashed_folders.get_trashed_folder_by_id(folder_id, fields?, extra_headers?) -> TrashFolder +- client.trashed_folders.delete_trashed_folder_by_id(folder_id, extra_headers?) -> None + +# Folder metadata + +Examples: [docs/folder_metadata.md](docs/folder_metadata.md) + +Methods: + +- client.folder_metadata.get_folder_metadata(folder_id, extra_headers?) -> Metadatas +- client.folder_metadata.get_folder_metadata_by_id(folder_id, scope, template_key, extra_headers?) -> MetadataFull +- client.folder_metadata.create_folder_metadata_by_id(folder_id, scope, template_key, request_body, extra_headers?) -> MetadataFull +- client.folder_metadata.update_folder_metadata_by_id(folder_id, scope, template_key, request_body, extra_headers?) -> MetadataFull +- client.folder_metadata.delete_folder_metadata_by_id(folder_id, scope, template_key, extra_headers?) -> None + +# Folder classifications + +Examples: [docs/folder_classifications.md](docs/folder_classifications.md) + +Methods: + +- client.folder_classifications.get_classification_on_folder(folder_id, extra_headers?) -> Classification +- client.folder_classifications.add_classification_to_folder(folder_id, box_security_classification_key?, extra_headers?) -> Classification +- client.folder_classifications.update_classification_on_folder(folder_id, request_body, extra_headers?) -> Classification +- client.folder_classifications.delete_classification_from_folder(folder_id, extra_headers?) -> None + +# Trashed items + +Examples: [docs/trashed_items.md](docs/trashed_items.md) + +Methods: + +- client.trashed_items.get_trashed_items(fields?, limit?, offset?, usemarker?, marker?, direction?, sort?, extra_headers?) -> Items + +# Folder watermarks + +Examples: [docs/folder_watermarks.md](docs/folder_watermarks.md) + +Methods: + +- client.folder_watermarks.get_folder_watermark(folder_id, extra_headers?) -> Watermark +- client.folder_watermarks.update_folder_watermark(folder_id, watermark, extra_headers?) -> Watermark +- client.folder_watermarks.delete_folder_watermark(folder_id, extra_headers?) -> None + +# Folder locks + +Examples: [docs/folder_locks.md](docs/folder_locks.md) + +Methods: + +- client.folder_locks.get_folder_locks(folder_id, extra_headers?) -> FolderLocks +- client.folder_locks.create_folder_lock(folder, locked_operations?, extra_headers?) -> FolderLock +- client.folder_locks.delete_folder_lock_by_id(folder_lock_id, extra_headers?) -> None + +# Metadata templates + +Examples: [docs/metadata_templates.md](docs/metadata_templates.md) + +Methods: + +- client.metadata_templates.get_metadata_templates_by_instance_id(metadata_instance_id, marker?, limit?, extra_headers?) -> MetadataTemplates +- client.metadata_templates.get_metadata_template(scope, template_key, extra_headers?) -> MetadataTemplate +- client.metadata_templates.update_metadata_template(scope, template_key, request_body, extra_headers?) -> MetadataTemplate +- client.metadata_templates.delete_metadata_template(scope, template_key, extra_headers?) -> None +- client.metadata_templates.get_metadata_template_by_id(template_id, extra_headers?) -> MetadataTemplate +- client.metadata_templates.get_global_metadata_templates(marker?, limit?, extra_headers?) -> MetadataTemplates +- client.metadata_templates.get_enterprise_metadata_templates(marker?, limit?, extra_headers?) -> MetadataTemplates +- client.metadata_templates.create_metadata_template(scope, display_name, template_key?, hidden?, fields?, copy_instance_on_item_copy?, extra_headers?) -> MetadataTemplate + +# Classifications + +Examples: [docs/classifications.md](docs/classifications.md) + +Methods: + +- client.classifications.get_classification_template(extra_headers?) -> ClassificationTemplate +- client.classifications.add_classification(request_body, extra_headers?) -> ClassificationTemplate +- client.classifications.update_classification(request_body, extra_headers?) -> ClassificationTemplate +- client.classifications.create_classification_template(fields, scope?, template_key?, display_name?, hidden?, copy_instance_on_item_copy?, extra_headers?) -> ClassificationTemplate + +# Metadata cascade policies + +Examples: [docs/metadata_cascade_policies.md](docs/metadata_cascade_policies.md) + +Methods: + +- client.metadata_cascade_policies.get_metadata_cascade_policies(folder_id, owner_enterprise_id?, marker?, offset?, extra_headers?) -> MetadataCascadePolicies +- client.metadata_cascade_policies.create_metadata_cascade_policy(folder_id, scope, template_key, extra_headers?) -> MetadataCascadePolicy +- client.metadata_cascade_policies.get_metadata_cascade_policy_by_id(metadata_cascade_policy_id, extra_headers?) -> MetadataCascadePolicy +- client.metadata_cascade_policies.delete_metadata_cascade_policy_by_id(metadata_cascade_policy_id, extra_headers?) -> None +- client.metadata_cascade_policies.apply_metadata_cascade_policy(metadata_cascade_policy_id, conflict_resolution, extra_headers?) -> None + +# Search + +Examples: [docs/search.md](docs/search.md) + +Methods: + +- client.search.search_by_metadata_query(from_, ancestor_folder_id, query?, query_params?, order_by?, limit?, marker?, fields?, extra_headers?) -> MetadataQueryResults +- client.search.search_for_content(query?, scope?, file_extensions?, created_at_range?, updated_at_range?, size_range?, owner_user_ids?, recent_updater_user_ids?, ancestor_folder_ids?, content_types?, type?, trash_content?, mdfilters?, sort?, direction?, limit?, include_recent_shared_links?, fields?, offset?, deleted_user_ids?, deleted_at_range?, extra_headers?) -> Union[SearchResults, SearchResultsWithSharedLinks] + +# User collaborations + +Examples: [docs/user_collaborations.md](docs/user_collaborations.md) + +Methods: + +- client.user_collaborations.get_collaboration_by_id(collaboration_id, fields?, extra_headers?) -> Collaboration +- client.user_collaborations.update_collaboration_by_id(collaboration_id, role, status?, expires_at?, can_view_path?, extra_headers?) -> Optional[Collaboration] +- client.user_collaborations.delete_collaboration_by_id(collaboration_id, extra_headers?) -> None +- client.user_collaborations.create_collaboration(item, accessible_by, role, is_access_only?, can_view_path?, expires_at?, fields?, notify?, extra_headers?) -> Collaboration + +# Task assignments + +Examples: [docs/task_assignments.md](docs/task_assignments.md) + +Methods: + +- client.task_assignments.get_task_assignments(task_id, extra_headers?) -> TaskAssignments +- client.task_assignments.create_task_assignment(task, assign_to, extra_headers?) -> TaskAssignment +- client.task_assignments.get_task_assignment_by_id(task_assignment_id, extra_headers?) -> TaskAssignment +- client.task_assignments.update_task_assignment_by_id(task_assignment_id, message?, resolution_state?, extra_headers?) -> TaskAssignment +- client.task_assignments.delete_task_assignment_by_id(task_assignment_id, extra_headers?) -> None + +# Shared links files + +Examples: [docs/shared_links_files.md](docs/shared_links_files.md) + +Methods: + +- client.shared_links_files.find_file_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> FileFull +- client.shared_links_files.get_shared_link_for_file(file_id, fields, extra_headers?) -> FileFull +- client.shared_links_files.add_share_link_to_file(file_id, fields, shared_link?, extra_headers?) -> FileFull +- client.shared_links_files.update_shared_link_on_file(file_id, fields, shared_link?, extra_headers?) -> FileFull +- client.shared_links_files.remove_shared_link_from_file(file_id, fields, shared_link?, extra_headers?) -> FileFull + +# Shared links folders + +Examples: [docs/shared_links_folders.md](docs/shared_links_folders.md) + +Methods: + +- client.shared_links_folders.find_folder_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> FolderFull +- client.shared_links_folders.get_shared_link_for_folder(folder_id, fields, extra_headers?) -> FolderFull +- client.shared_links_folders.add_share_link_to_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull +- client.shared_links_folders.update_shared_link_on_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull +- client.shared_links_folders.remove_shared_link_from_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull + +# Web links + +Examples: [docs/web_links.md](docs/web_links.md) + +Methods: + +- client.web_links.create_web_link(url, parent, name?, description?, extra_headers?) -> WebLink +- client.web_links.get_web_link_by_id(web_link_id, boxapi?, extra_headers?) -> WebLink +- client.web_links.update_web_link_by_id(web_link_id, url?, parent?, name?, description?, shared_link?, extra_headers?) -> WebLink +- client.web_links.delete_web_link_by_id(web_link_id, extra_headers?) -> None + +# Trashed web links + +Examples: [docs/trashed_web_links.md](docs/trashed_web_links.md) + +Methods: + +- client.trashed_web_links.restore_weblink_from_trash(web_link_id, name?, parent?, fields?, extra_headers?) -> TrashWebLinkRestored +- client.trashed_web_links.get_trashed_web_link_by_id(web_link_id, fields?, extra_headers?) -> TrashWebLink +- client.trashed_web_links.delete_trashed_web_link_by_id(web_link_id, extra_headers?) -> None + +# Shared links web links + +Examples: [docs/shared_links_web_links.md](docs/shared_links_web_links.md) + +Methods: + +- client.shared_links_web_links.find_web_link_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> WebLink +- client.shared_links_web_links.get_shared_link_for_web_link(web_link_id, fields, extra_headers?) -> WebLink +- client.shared_links_web_links.add_share_link_to_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink +- client.shared_links_web_links.update_shared_link_on_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink +- client.shared_links_web_links.remove_shared_link_from_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink + +# Shared links app items + +Examples: [docs/shared_links_app_items.md](docs/shared_links_app_items.md) + +Methods: + +- client.shared_links_app_items.find_app_item_for_shared_link(boxapi, extra_headers?) -> AppItem + +# Users + +Examples: [docs/users.md](docs/users.md) + +Methods: + +- client.users.get_users(filter_term?, user_type?, external_app_user_id?, fields?, offset?, limit?, usemarker?, marker?, extra_headers?) -> Users +- client.users.create_user(name, login?, is_platform_access_only?, role?, language?, is_sync_enabled?, job_title?, phone?, address?, space_amount?, tracking_codes?, can_see_managed_users?, timezone?, is_external_collab_restricted?, is_exempt_from_device_limits?, is_exempt_from_login_verification?, status?, external_app_user_id?, fields?, extra_headers?) -> UserFull +- client.users.get_user_me(fields?, extra_headers?) -> UserFull +- client.users.get_user_by_id(user_id, fields?, extra_headers?) -> UserFull +- client.users.update_user_by_id(user_id, enterprise?, notify?, name?, login?, role?, language?, is_sync_enabled?, job_title?, phone?, address?, tracking_codes?, can_see_managed_users?, timezone?, is_external_collab_restricted?, is_exempt_from_device_limits?, is_exempt_from_login_verification?, is_password_reset_required?, status?, space_amount?, notification_email?, external_app_user_id?, fields?, extra_headers?) -> UserFull +- client.users.delete_user_by_id(user_id, notify?, force?, extra_headers?) -> None + +# Session termination + +Examples: [docs/session_termination.md](docs/session_termination.md) + +Methods: + +- client.session_termination.terminate_users_sessions(user_ids, user_logins, extra_headers?) -> SessionTerminationMessage +- client.session_termination.terminate_groups_sessions(group_ids, extra_headers?) -> SessionTerminationMessage + +# Avatars + +Examples: [docs/avatars.md](docs/avatars.md) + +Methods: + +- client.avatars.get_user_avatar(user_id, extra_headers?) -> ByteStream +- client.avatars.create_user_avatar(user_id, pic, pic_file_name?, pic_content_type?, extra_headers?) -> UserAvatar +- client.avatars.delete_user_avatar(user_id, extra_headers?) -> None + +# Transfer + +Examples: [docs/transfer.md](docs/transfer.md) + +Methods: + +- client.transfer.transfer_owned_folder(user_id, owned_by, fields?, notify?, extra_headers?) -> FolderFull + +# Email aliases + +Examples: [docs/email_aliases.md](docs/email_aliases.md) + +Methods: + +- client.email_aliases.get_user_email_aliases(user_id, extra_headers?) -> EmailAliases +- client.email_aliases.create_user_email_alias(user_id, email, extra_headers?) -> EmailAlias +- client.email_aliases.delete_user_email_alias_by_id(user_id, email_alias_id, extra_headers?) -> None + +# Memberships + +Examples: [docs/memberships.md](docs/memberships.md) + +Methods: + +- client.memberships.get_user_memberships(user_id, limit?, offset?, extra_headers?) -> GroupMemberships +- client.memberships.get_group_memberships(group_id, limit?, offset?, extra_headers?) -> GroupMemberships +- client.memberships.create_group_membership(user, group, role?, configurable_permissions?, fields?, extra_headers?) -> GroupMembership +- client.memberships.get_group_membership_by_id(group_membership_id, fields?, extra_headers?) -> GroupMembership +- client.memberships.update_group_membership_by_id(group_membership_id, role?, configurable_permissions?, fields?, extra_headers?) -> GroupMembership +- client.memberships.delete_group_membership_by_id(group_membership_id, extra_headers?) -> None + +# Invites + +Examples: [docs/invites.md](docs/invites.md) + +Methods: + +- client.invites.create_invite(enterprise, actionable_by, fields?, extra_headers?) -> Invite +- client.invites.get_invite_by_id(invite_id, fields?, extra_headers?) -> Invite + +# Groups + +Examples: [docs/groups.md](docs/groups.md) + +Methods: + +- client.groups.get_groups(filter_term?, fields?, limit?, offset?, extra_headers?) -> Groups +- client.groups.create_group(name, provenance?, external_sync_identifier?, description?, invitability_level?, member_viewability_level?, fields?, extra_headers?) -> GroupFull +- client.groups.get_group_by_id(group_id, fields?, extra_headers?) -> GroupFull +- client.groups.update_group_by_id(group_id, name?, provenance?, external_sync_identifier?, description?, invitability_level?, member_viewability_level?, fields?, extra_headers?) -> GroupFull +- client.groups.delete_group_by_id(group_id, extra_headers?) -> None + +# Webhooks + +Examples: [docs/webhooks.md](docs/webhooks.md) + +Methods: + +- client.webhooks.get_webhooks(marker?, limit?, extra_headers?) -> Webhooks +- client.webhooks.create_webhook(target, address, triggers, extra_headers?) -> Webhook +- client.webhooks.get_webhook_by_id(webhook_id, extra_headers?) -> Webhook +- client.webhooks.update_webhook_by_id(webhook_id, target?, address?, triggers?, extra_headers?) -> Webhook +- client.webhooks.delete_webhook_by_id(webhook_id, extra_headers?) -> None +- client.webhooks.validate_message(body, headers, primary_key, secondary_key?, max_age?) -> bool + +# Events + +Examples: [docs/events.md](docs/events.md) + +Methods: + +- client.events.get_events_with_long_polling(extra_headers?) -> RealtimeServers +- client.events.get_events(stream_type?, stream_position?, limit?, event_type?, created_after?, created_before?, extra_headers?) -> Events +- client.events.get_event_stream(query_params?, headers?) -> EventStream + +# Collections + +Examples: [docs/collections.md](docs/collections.md) + +Methods: + +- client.collections.get_collections(fields?, offset?, limit?, extra_headers?) -> Collections +- client.collections.get_collection_items(collection_id, fields?, offset?, limit?, extra_headers?) -> ItemsOffsetPaginated +- client.collections.get_collection_by_id(collection_id, extra_headers?) -> Collection + +# Recent items + +Examples: [docs/recent_items.md](docs/recent_items.md) + +Methods: + +- client.recent_items.get_recent_items(fields?, limit?, marker?, extra_headers?) -> RecentItems + +# Retention policies + +Examples: [docs/retention_policies.md](docs/retention_policies.md) + +Methods: + +- client.retention_policies.get_retention_policies(policy_name?, policy_type?, created_by_user_id?, fields?, limit?, marker?, extra_headers?) -> RetentionPolicies +- client.retention_policies.create_retention_policy(policy_name, policy_type, disposition_action, description?, retention_length?, retention_type?, can_owner_extend_retention?, are_owners_notified?, custom_notification_recipients?, extra_headers?) -> RetentionPolicy +- client.retention_policies.get_retention_policy_by_id(retention_policy_id, fields?, extra_headers?) -> RetentionPolicy +- client.retention_policies.update_retention_policy_by_id(retention_policy_id, policy_name?, description?, disposition_action?, retention_type?, retention_length?, status?, can_owner_extend_retention?, are_owners_notified?, custom_notification_recipients?, extra_headers?) -> RetentionPolicy +- client.retention_policies.delete_retention_policy_by_id(retention_policy_id, extra_headers?) -> None + +# Retention policy assignments + +Examples: [docs/retention_policy_assignments.md](docs/retention_policy_assignments.md) + +Methods: + +- client.retention_policy_assignments.get_retention_policy_assignments(retention_policy_id, type?, fields?, marker?, limit?, extra_headers?) -> RetentionPolicyAssignments +- client.retention_policy_assignments.create_retention_policy_assignment(policy_id, assign_to, filter_fields?, start_date_field?, extra_headers?) -> RetentionPolicyAssignment +- client.retention_policy_assignments.get_retention_policy_assignment_by_id(retention_policy_assignment_id, fields?, extra_headers?) -> RetentionPolicyAssignment +- client.retention_policy_assignments.delete_retention_policy_assignment_by_id(retention_policy_assignment_id, extra_headers?) -> None +- client.retention_policy_assignments.get_files_under_retention_policy_assignment(retention_policy_assignment_id, marker?, limit?, extra_headers?) -> FilesUnderRetention + +# Legal hold policies + +Examples: [docs/legal_hold_policies.md](docs/legal_hold_policies.md) + +Methods: + +- client.legal_hold_policies.get_legal_hold_policies(policy_name?, fields?, marker?, limit?, extra_headers?) -> LegalHoldPolicies +- client.legal_hold_policies.create_legal_hold_policy(policy_name, description?, filter_started_at?, filter_ended_at?, is_ongoing?, extra_headers?) -> LegalHoldPolicy +- client.legal_hold_policies.get_legal_hold_policy_by_id(legal_hold_policy_id, extra_headers?) -> LegalHoldPolicy +- client.legal_hold_policies.update_legal_hold_policy_by_id(legal_hold_policy_id, policy_name?, description?, release_notes?, extra_headers?) -> LegalHoldPolicy +- client.legal_hold_policies.delete_legal_hold_policy_by_id(legal_hold_policy_id, extra_headers?) -> None + +# Legal hold policy assignments + +Examples: [docs/legal_hold_policy_assignments.md](docs/legal_hold_policy_assignments.md) + +Methods: + +- client.legal_hold_policy_assignments.get_legal_hold_policy_assignments(policy_id, assign_to_type?, assign_to_id?, marker?, limit?, fields?, extra_headers?) -> LegalHoldPolicyAssignments +- client.legal_hold_policy_assignments.create_legal_hold_policy_assignment(policy_id, assign_to, extra_headers?) -> LegalHoldPolicyAssignment +- client.legal_hold_policy_assignments.get_legal_hold_policy_assignment_by_id(legal_hold_policy_assignment_id, extra_headers?) -> LegalHoldPolicyAssignment +- client.legal_hold_policy_assignments.delete_legal_hold_policy_assignment_by_id(legal_hold_policy_assignment_id, extra_headers?) -> None +- client.legal_hold_policy_assignments.get_legal_hold_policy_assignment_file_on_hold(legal_hold_policy_assignment_id, marker?, limit?, fields?, extra_headers?) -> FilesOnHold + +# File version retentions + +Examples: [docs/file_version_retentions.md](docs/file_version_retentions.md) + +Methods: + +- client.file_version_retentions.get_file_version_retentions(file_id?, file_version_id?, policy_id?, disposition_action?, disposition_before?, disposition_after?, limit?, marker?, extra_headers?) -> FileVersionRetentions +- client.file_version_retentions.get_file_version_retention_by_id(file_version_retention_id, extra_headers?) -> FileVersionRetention + +# File version legal holds + +Examples: [docs/file_version_legal_holds.md](docs/file_version_legal_holds.md) + +Methods: + +- client.file_version_legal_holds.get_file_version_legal_hold_by_id(file_version_legal_hold_id, extra_headers?) -> FileVersionLegalHold +- client.file_version_legal_holds.get_file_version_legal_holds(policy_id, marker?, limit?, extra_headers?) -> FileVersionLegalHolds + +# Shield information barriers + +Examples: [docs/shield_information_barriers.md](docs/shield_information_barriers.md) + +Methods: + +- client.shield_information_barriers.get_shield_information_barrier_by_id(shield_information_barrier_id, extra_headers?) -> ShieldInformationBarrier +- client.shield_information_barriers.update_shield_information_barrier_status(id, status, extra_headers?) -> ShieldInformationBarrier +- client.shield_information_barriers.get_shield_information_barriers(marker?, limit?, extra_headers?) -> ShieldInformationBarriers +- client.shield_information_barriers.create_shield_information_barrier(enterprise, extra_headers?) -> ShieldInformationBarrier + +# Shield information barrier reports + +Examples: [docs/shield_information_barrier_reports.md](docs/shield_information_barrier_reports.md) + +Methods: + +- client.shield_information_barrier_reports.get_shield_information_barrier_reports(shield_information_barrier_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierReports +- client.shield_information_barrier_reports.create_shield_information_barrier_report(shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierReport +- client.shield_information_barrier_reports.get_shield_information_barrier_report_by_id(shield_information_barrier_report_id, extra_headers?) -> ShieldInformationBarrierReport + +# Shield information barrier segments + +Examples: [docs/shield_information_barrier_segments.md](docs/shield_information_barrier_segments.md) + +Methods: + +- client.shield_information_barrier_segments.get_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, extra_headers?) -> ShieldInformationBarrierSegment +- client.shield_information_barrier_segments.delete_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, extra_headers?) -> None +- client.shield_information_barrier_segments.update_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, name?, description?, extra_headers?) -> ShieldInformationBarrierSegment +- client.shield_information_barrier_segments.get_shield_information_barrier_segments(shield_information_barrier_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegments +- client.shield_information_barrier_segments.create_shield_information_barrier_segment(shield_information_barrier, name, description?, extra_headers?) -> ShieldInformationBarrierSegment + +# Shield information barrier segment members + +Examples: [docs/shield_information_barrier_segment_members.md](docs/shield_information_barrier_segment_members.md) + +Methods: + +- client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_member_by_id(shield_information_barrier_segment_member_id, extra_headers?) -> ShieldInformationBarrierSegmentMember +- client.shield_information_barrier_segment_members.delete_shield_information_barrier_segment_member_by_id(shield_information_barrier_segment_member_id, extra_headers?) -> None +- client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_members(shield_information_barrier_segment_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegmentMembers +- client.shield_information_barrier_segment_members.create_shield_information_barrier_segment_member(shield_information_barrier_segment, user, type?, shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierSegmentMember + +# Shield information barrier segment restrictions + +Examples: [docs/shield_information_barrier_segment_restrictions.md](docs/shield_information_barrier_segment_restrictions.md) + +Methods: + +- client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restriction_by_id(shield_information_barrier_segment_restriction_id, extra_headers?) -> ShieldInformationBarrierSegmentRestriction +- client.shield_information_barrier_segment_restrictions.delete_shield_information_barrier_segment_restriction_by_id(shield_information_barrier_segment_restriction_id, extra_headers?) -> None +- client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restrictions(shield_information_barrier_segment_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegmentRestrictions +- client.shield_information_barrier_segment_restrictions.create_shield_information_barrier_segment_restriction(shield_information_barrier_segment, restricted_segment, type?, shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierSegmentRestriction + +# Device pinners + +Examples: [docs/device_pinners.md](docs/device_pinners.md) + +Methods: + +- client.device_pinners.get_device_pinner_by_id(device_pinner_id, extra_headers?) -> DevicePinner +- client.device_pinners.delete_device_pinner_by_id(device_pinner_id, extra_headers?) -> None +- client.device_pinners.get_enterprise_device_pinners(enterprise_id, marker?, limit?, direction?, extra_headers?) -> DevicePinners + +# Terms of services + +Examples: [docs/terms_of_services.md](docs/terms_of_services.md) + +Methods: + +- client.terms_of_services.get_terms_of_service(tos_type?, extra_headers?) -> TermsOfServices +- client.terms_of_services.create_terms_of_service(status, text, tos_type?, extra_headers?) -> TermsOfService +- client.terms_of_services.get_terms_of_service_by_id(terms_of_service_id, extra_headers?) -> TermsOfService +- client.terms_of_services.update_terms_of_service_by_id(terms_of_service_id, status, text, extra_headers?) -> TermsOfService + +# Terms of service user statuses + +Examples: [docs/terms_of_service_user_statuses.md](docs/terms_of_service_user_statuses.md) + +Methods: + +- client.terms_of_service_user_statuses.get_terms_of_service_user_statuses(tos_id, user_id?, extra_headers?) -> TermsOfServiceUserStatuses +- client.terms_of_service_user_statuses.create_terms_of_service_status_for_user(tos, user, is_accepted, extra_headers?) -> TermsOfServiceUserStatus +- client.terms_of_service_user_statuses.update_terms_of_service_status_for_user_by_id(terms_of_service_user_status_id, is_accepted, extra_headers?) -> TermsOfServiceUserStatus + +# Collaboration allowlist entries + +Examples: [docs/collaboration_allowlist_entries.md](docs/collaboration_allowlist_entries.md) + +Methods: + +- client.collaboration_allowlist_entries.get_collaboration_whitelist_entries(marker?, limit?, extra_headers?) -> CollaborationAllowlistEntries +- client.collaboration_allowlist_entries.create_collaboration_whitelist_entry(domain, direction, extra_headers?) -> CollaborationAllowlistEntry +- client.collaboration_allowlist_entries.get_collaboration_whitelist_entry_by_id(collaboration_whitelist_entry_id, extra_headers?) -> CollaborationAllowlistEntry +- client.collaboration_allowlist_entries.delete_collaboration_whitelist_entry_by_id(collaboration_whitelist_entry_id, extra_headers?) -> None + +# Collaboration allowlist exempt targets + +Examples: [docs/collaboration_allowlist_exempt_targets.md](docs/collaboration_allowlist_exempt_targets.md) + +Methods: + +- client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_targets(marker?, limit?, extra_headers?) -> CollaborationAllowlistExemptTargets +- client.collaboration_allowlist_exempt_targets.create_collaboration_whitelist_exempt_target(user, extra_headers?) -> CollaborationAllowlistExemptTarget +- client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_target_by_id(collaboration_whitelist_exempt_target_id, extra_headers?) -> CollaborationAllowlistExemptTarget +- client.collaboration_allowlist_exempt_targets.delete_collaboration_whitelist_exempt_target_by_id(collaboration_whitelist_exempt_target_id, extra_headers?) -> None + +# Storage policies + +Examples: [docs/storage_policies.md](docs/storage_policies.md) + +Methods: + +- client.storage_policies.get_storage_policies(fields?, marker?, limit?, extra_headers?) -> StoragePolicies +- client.storage_policies.get_storage_policy_by_id(storage_policy_id, extra_headers?) -> StoragePolicy + +# Storage policy assignments + +Examples: [docs/storage_policy_assignments.md](docs/storage_policy_assignments.md) + +Methods: + +- client.storage_policy_assignments.get_storage_policy_assignments(resolved_for_type, resolved_for_id, marker?, extra_headers?) -> StoragePolicyAssignments +- client.storage_policy_assignments.create_storage_policy_assignment(storage_policy, assigned_to, extra_headers?) -> StoragePolicyAssignment +- client.storage_policy_assignments.get_storage_policy_assignment_by_id(storage_policy_assignment_id, extra_headers?) -> StoragePolicyAssignment +- client.storage_policy_assignments.update_storage_policy_assignment_by_id(storage_policy_assignment_id, storage_policy, extra_headers?) -> StoragePolicyAssignment +- client.storage_policy_assignments.delete_storage_policy_assignment_by_id(storage_policy_assignment_id, extra_headers?) -> None + +# Zip downloads + +Examples: [docs/zip_downloads.md](docs/zip_downloads.md) + +Methods: + +- client.zip_downloads.create_zip_download(items, download_file_name?, extra_headers?) -> ZipDownload +- client.zip_downloads.get_zip_download_content(download_url, extra_headers?) -> ByteStream +- client.zip_downloads.get_zip_download_status(status_url, extra_headers?) -> ZipDownloadStatus +- client.zip_downloads.download_zip(items, download_file_name?, extra_headers?) -> ByteStream + +# Sign requests + +Examples: [docs/sign_requests.md](docs/sign_requests.md) + +Methods: + +- client.sign_requests.cancel_sign_request(sign_request_id, extra_headers?) -> SignRequest +- client.sign_requests.resend_sign_request(sign_request_id, extra_headers?) -> None +- client.sign_requests.get_sign_request_by_id(sign_request_id, extra_headers?) -> SignRequest +- client.sign_requests.get_sign_requests(marker?, limit?, senders?, shared_requests?, extra_headers?) -> SignRequests +- client.sign_requests.create_sign_request(signers, source_files?, signature_color?, parent_folder?, is_document_preparation_needed?, redirect_url?, declined_redirect_url?, are_text_signatures_enabled?, email_subject?, email_message?, are_reminders_enabled?, name?, prefill_tags?, days_valid?, external_id?, template_id?, external_system_name?, extra_headers?) -> SignRequest + +# Workflows + +Examples: [docs/workflows.md](docs/workflows.md) + +Methods: + +- client.workflows.get_workflows(folder_id, trigger_type?, limit?, marker?, extra_headers?) -> Workflows +- client.workflows.start_workflow(workflow_id, flow, files, folder, type?, outcomes?, extra_headers?) -> None + +# Sign templates + +Examples: [docs/sign_templates.md](docs/sign_templates.md) + +Methods: + +- client.sign_templates.get_sign_templates(marker?, limit?, extra_headers?) -> SignTemplates +- client.sign_templates.get_sign_template_by_id(template_id, extra_headers?) -> SignTemplate + +# Integration mappings + +Examples: [docs/integration_mappings.md](docs/integration_mappings.md) + +Methods: + +- client.integration_mappings.get_slack_integration_mapping(marker?, limit?, partner_item_type?, partner_item_id?, box_item_id?, box_item_type?, is_manually_created?, extra_headers?) -> IntegrationMappings +- client.integration_mappings.create_slack_integration_mapping(partner_item, box_item, options?, extra_headers?) -> IntegrationMapping +- client.integration_mappings.update_slack_integration_mapping_by_id(integration_mapping_id, box_item?, options?, extra_headers?) -> IntegrationMapping +- client.integration_mappings.delete_slack_integration_mapping_by_id(integration_mapping_id, extra_headers?) -> None +- client.integration_mappings.get_teams_integration_mapping(partner_item_type?, partner_item_id?, box_item_id?, box_item_type?, extra_headers?) -> IntegrationMappingsTeams +- client.integration_mappings.create_teams_integration_mapping(partner_item, box_item, extra_headers?) -> IntegrationMappingTeams +- client.integration_mappings.update_teams_integration_mapping_by_id(integration_mapping_id, box_item?, extra_headers?) -> IntegrationMappingTeams +- client.integration_mappings.delete_teams_integration_mapping_by_id(integration_mapping_id, extra_headers?) -> None + +# Ai + +Examples: [docs/ai.md](docs/ai.md) + +Methods: + +- client.ai.create_ai_ask(mode, prompt, items, dialogue_history?, include_citations?, ai_agent?, extra_headers?) -> Optional[AiResponseFull] +- client.ai.create_ai_text_gen(prompt, items, dialogue_history?, ai_agent?, extra_headers?) -> AiResponse +- client.ai.get_ai_agent_default_config(mode, language?, model?, extra_headers?) -> Union[AiAgentAsk, AiAgentTextGen, AiAgentExtract, AiAgentExtractStructured] +- client.ai.create_ai_extract(prompt, items, ai_agent?, extra_headers?) -> AiResponse +- client.ai.create_ai_extract_structured(items, metadata_template?, fields?, ai_agent?, extra_headers?) -> AiExtractStructuredResponse + +# Ai studio + +Examples: [docs/ai_studio.md](docs/ai_studio.md) + +Methods: + +- client.ai_studio.get_ai_agents(mode?, fields?, agent_state?, include_box_default?, marker?, limit?, extra_headers?) -> AiMultipleAgentResponse +- client.ai_studio.create_ai_agent(name, access_state, type?, icon_reference?, allowed_entities?, ask?, text_gen?, extract?, extra_headers?) -> AiSingleAgentResponseFull +- client.ai_studio.update_ai_agent_by_id(agent_id, name, access_state, type?, icon_reference?, allowed_entities?, ask?, text_gen?, extract?, extra_headers?) -> AiSingleAgentResponseFull +- client.ai_studio.get_ai_agent_by_id(agent_id, fields?, extra_headers?) -> AiSingleAgentResponseFull +- client.ai_studio.delete_ai_agent_by_id(agent_id, extra_headers?) -> None + +# Docgen template + +Examples: [docs/docgen_template.md](docs/docgen_template.md) + +Methods: + +- client.docgen_template.create_docgen_template_v2025_r0(file, box_version?, extra_headers?) -> DocGenTemplateBaseV2025R0 +- client.docgen_template.get_docgen_templates_v2025_r0(marker?, limit?, box_version?, extra_headers?) -> DocGenTemplatesV2025R0 +- client.docgen_template.delete_docgen_template_by_id_v2025_r0(template_id, box_version?, extra_headers?) -> None +- client.docgen_template.get_docgen_template_by_id_v2025_r0(template_id, box_version?, extra_headers?) -> DocGenTemplateV2025R0 +- client.docgen_template.get_docgen_template_tags_v2025_r0(template_id, template_version_id?, marker?, limit?, box_version?, extra_headers?) -> DocGenTagsV2025R0 +- client.docgen_template.get_docgen_template_job_by_id_v2025_r0(template_id, marker?, limit?, box_version?, extra_headers?) -> DocGenJobsV2025R0 + +# Docgen + +Examples: [docs/docgen.md](docs/docgen.md) + +Methods: + +- client.docgen.get_docgen_job_by_id_v2025_r0(job_id, box_version?, extra_headers?) -> DocGenJobV2025R0 +- client.docgen.get_docgen_jobs_v2025_r0(marker?, limit?, box_version?, extra_headers?) -> DocGenJobsFullV2025R0 +- client.docgen.get_docgen_batch_job_by_id_v2025_r0(batch_id, marker?, limit?, box_version?, extra_headers?) -> DocGenJobsV2025R0 +- client.docgen.create_docgen_batch_v2025_r0(file, input_source, destination_folder, output_type, document_generation_data, file_version?, box_version?, extra_headers?) -> DocGenBatchBaseV2025R0 + +# Hubs + +Examples: [docs/hubs.md](docs/hubs.md) + +Methods: + +- client.hubs.get_hubs_v2025_r0(query?, scope?, sort?, direction?, marker?, limit?, box_version?, extra_headers?) -> HubsV2025R0 +- client.hubs.create_hub_v2025_r0(title, description?, box_version?, extra_headers?) -> HubV2025R0 +- client.hubs.get_enterprise_hubs_v2025_r0(query?, sort?, direction?, marker?, limit?, box_version?, extra_headers?) -> HubsV2025R0 +- client.hubs.get_hub_by_id_v2025_r0(hub_id, box_version?, extra_headers?) -> HubV2025R0 +- client.hubs.update_hub_by_id_v2025_r0(hub_id, title?, description?, is_ai_enabled?, is_collaboration_restricted_to_enterprise?, can_non_owners_invite?, can_shared_link_be_created?, box_version?, extra_headers?) -> HubV2025R0 +- client.hubs.delete_hub_by_id_v2025_r0(hub_id, box_version?, extra_headers?) -> None +- client.hubs.copy_hub_v2025_r0(hub_id, title?, description?, box_version?, extra_headers?) -> HubV2025R0 + +# Hub collaborations + +Examples: [docs/hub_collaborations.md](docs/hub_collaborations.md) + +Methods: + +- client.hub_collaborations.get_hub_collaborations_v2025_r0(hub_id, marker?, limit?, box_version?, extra_headers?) -> HubCollaborationsV2025R0 +- client.hub_collaborations.create_hub_collaboration_v2025_r0(hub, accessible_by, role, box_version?, extra_headers?) -> HubCollaborationV2025R0 +- client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, box_version?, extra_headers?) -> HubCollaborationV2025R0 +- client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, role?, box_version?, extra_headers?) -> HubCollaborationV2025R0 +- client.hub_collaborations.delete_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, box_version?, extra_headers?) -> None + +# Hub items + +Examples: [docs/hub_items.md](docs/hub_items.md) + +Methods: + +- client.hub_items.get_hub_items_v2025_r0(hub_id, marker?, limit?, box_version?, extra_headers?) -> HubItemsV2025R0 +- client.hub_items.manage_hub_items_v2025_r0(hub_id, operations?, box_version?, extra_headers?) -> HubItemsManageResponseV2025R0 + +# Shield lists + +Examples: [docs/shield_lists.md](docs/shield_lists.md) + +Methods: + +- client.shield_lists.get_shield_lists_v2025_r0(box_version?, extra_headers?) -> ShieldListsV2025R0 +- client.shield_lists.create_shield_list_v2025_r0(name, content, description?, box_version?, extra_headers?) -> ShieldListV2025R0 +- client.shield_lists.get_shield_list_by_id_v2025_r0(shield_list_id, box_version?, extra_headers?) -> ShieldListV2025R0 +- client.shield_lists.delete_shield_list_by_id_v2025_r0(shield_list_id, box_version?, extra_headers?) -> None +- client.shield_lists.update_shield_list_by_id_v2025_r0(shield_list_id, name, content, description?, box_version?, extra_headers?) -> ShieldListV2025R0 + +# Archives + +Examples: [docs/archives.md](docs/archives.md) + +Methods: + +- client.archives.get_archives_v2025_r0(limit?, marker?, box_version?, extra_headers?) -> ArchivesV2025R0 +- client.archives.create_archive_v2025_r0(name, box_version?, extra_headers?) -> ArchiveV2025R0 +- client.archives.delete_archive_by_id_v2025_r0(archive_id, box_version?, extra_headers?) -> None diff --git a/docs/README.md b/docs/README.md index a927c4a7..da4c90ef 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,8 @@ ## High-level Documentation +For a single-page list of every manager and method, see [api.md](../api.md). + General explanations of the available functionality and examples of how to use the SDK are available by topic: