Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "c370934", "specHash": "1e0848d", "version": "4.2.0" }
{ "engineHash": "c370934", "specHash": "9d069ca", "version": "4.2.0" }
6 changes: 3 additions & 3 deletions box_sdk_gen/managers/ai.py
Original file line number Diff line number Diff line change
Expand Up @@ -434,13 +434,13 @@ def create_ai_extract_structured(
To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)


or use the [metadata template API](g://metadata/templates/create).
or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create).


This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).


For information about supported file formats and languages, see the [Extract metadata from file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.

:param items: The items to be processed by the LLM. Currently you can use files only.
:type items: List[AiItemBase]
Expand Down
8 changes: 4 additions & 4 deletions box_sdk_gen/managers/archives.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def get_archives_v2025_r0(
"""
Retrieves archives for an enterprise.

To learn more about the archive APIs, see the [Archive API Guide](g://archives).
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

:param limit: The maximum number of items to return per page., defaults to None
:type limit: Optional[int], optional
Expand Down Expand Up @@ -109,7 +109,7 @@ def create_archive_v2025_r0(
"""
Creates an archive.

To learn more about the archive APIs, see the [Archive API Guide](g://archives).
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

:param name: The name of the archive.
:type name: str
Expand Down Expand Up @@ -156,7 +156,7 @@ def delete_archive_by_id_v2025_r0(
"""
Permanently deletes an archive.

To learn more about the archive APIs, see the [Archive API Guide](g://archives).
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

:param archive_id: The ID of the archive.
Example: "982312"
Expand Down Expand Up @@ -201,7 +201,7 @@ def update_archive_by_id_v2025_r0(
"""
Updates an archive.

To learn more about the archive APIs, see the [Archive API Guide](g://archives).
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

:param archive_id: The ID of the archive.
Example: "982312"
Expand Down
36 changes: 18 additions & 18 deletions box_sdk_gen/managers/chunked_uploads.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ def get_file_upload_session_by_url(
Return information about an upload session.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

:param url: URL of getFileUploadSessionById method
:type url: str
Expand Down Expand Up @@ -235,7 +235,7 @@ def get_file_upload_session_by_id(
"""
Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down Expand Up @@ -282,10 +282,10 @@ def upload_file_part_by_url(
Uploads a chunk of a file for an upload session.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param url: URL of uploadFilePart method
:type url: str
Expand Down Expand Up @@ -355,10 +355,10 @@ def upload_file_part(
"""
Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down Expand Up @@ -438,10 +438,10 @@ def delete_file_upload_session_by_url(
This cannot be reversed.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param url: URL of deleteFileUploadSessionById method
:type url: str
Expand Down Expand Up @@ -475,10 +475,10 @@ def delete_file_upload_session_by_id(
This cannot be reversed.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down Expand Up @@ -524,10 +524,10 @@ def get_file_upload_session_parts_by_url(
Return a list of the chunks uploaded to the upload session so far.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param url: URL of getFileUploadSessionParts method
:type url: str
Expand Down Expand Up @@ -572,10 +572,10 @@ def get_file_upload_session_parts(
"""
Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down Expand Up @@ -636,10 +636,10 @@ def create_file_upload_session_commit_by_url(
Close an upload session and create a file from the uploaded chunks.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param url: URL of createFileUploadSessionCommit method
:type url: str
Expand Down Expand Up @@ -711,10 +711,10 @@ def create_file_upload_session_commit(
"""
Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/file_classifications.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def __init__(

To list the available classifications in an enterprise,
use the classification API to retrieve the
[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)
[classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema)
which lists all available classification keys.
:type value: str
:param op: The value will always be `replace`., defaults to UpdateClassificationOnFileRequestBodyOpField.REPLACE
Expand Down Expand Up @@ -175,7 +175,7 @@ def add_classification_to_file(

To list the available classifications in an enterprise,
use the classification API to retrieve the
[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)
[classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema)
which lists all available classification keys., defaults to None
:type box_security_classification_key: Optional[str], optional
:param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/file_version_retentions.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def get_file_version_retentions(
To get information about files and file versions under retention,


see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

:param file_id: Filters results by files with this ID., defaults to None
:type file_id: Optional[str], optional
Expand Down Expand Up @@ -157,7 +157,7 @@ def get_file_version_retention_by_id(
To get information about files and file versions under retention,


see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

:param file_version_retention_id: The ID of the file version retention.
Example: "3424234"
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ def update_file_by_id(
Passing an empty array `[]` or `null` will remove
the file from all collections.

[1]: e://get-collections, defaults to None
[1]: https://developer.box.com/reference/get-collections, defaults to None
:type collections: Union[Optional[List[UpdateFileByIdCollections]], NullValue], optional
:param tags: The tags for this item. These tags are shown in
the Box web app and mobile apps next to an item.
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/folder_classifications.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def __init__(

To list the available classifications in an enterprise,
use the classification API to retrieve the
[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)
[classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema)
which lists all available classification keys.
:type value: str
:param op: The value will always be `replace`., defaults to UpdateClassificationOnFolderRequestBodyOpField.REPLACE
Expand Down Expand Up @@ -184,7 +184,7 @@ def add_classification_to_folder(

To list the available classifications in an enterprise,
use the classification API to retrieve the
[classification template](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)
[classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema)
which lists all available classification keys., defaults to None
:type box_security_classification_key: Optional[str], optional
:param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
Expand Down
6 changes: 3 additions & 3 deletions box_sdk_gen/managers/folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,13 +308,13 @@ def get_folder_by_id(
list of returned


[folder items](r://folder--full#param-item-collection).
[folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).


To fetch more items within the folder, use the


[Get items in a folder](e://get-folders-id-items) endpoint.
[Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.

:param folder_id: The unique identifier that represent a folder.

Expand Down Expand Up @@ -524,7 +524,7 @@ def update_folder_by_id(
Passing an empty array `[]` or `null` will remove
the folder from all collections.

[1]: e://get-collections, defaults to None
[1]: https://developer.box.com/reference/get-collections, defaults to None
:type collections: Union[Optional[List[UpdateFolderByIdCollections]], NullValue], optional
:param can_non_owners_view_collaborators: Restricts collaborators who are not the owner of
this folder from viewing other collaborations on
Expand Down
6 changes: 3 additions & 3 deletions box_sdk_gen/managers/metadata_cascade_policies.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@ def create_metadata_cascade_policy(
get all instances on a [file][file] or [folder][folder]
to inspect a template's key.

[list]: e://get-metadata-templates-enterprise
[file]: e://get-files-id-metadata
[folder]: e://get-folders-id-metadata
[list]: https://developer.box.com/reference/get-metadata-templates-enterprise
[file]: https://developer.box.com/reference/get-files-id-metadata
[folder]: https://developer.box.com/reference/get-folders-id-metadata
:type template_key: str
:param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
:type extra_headers: Optional[Dict[str, Optional[str]]], optional
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ def search_for_content(
When this parameter has been set to true,
the format of the response of this API changes to return
a list of [Search Results with
Shared Links](r://search_results_with_shared_links)., defaults to None
Shared Links](https://developer.box.com/reference/resources/search-results-with-shared-links)., defaults to None
:type include_recent_shared_links: Optional[bool], optional
:param fields: A comma-separated list of attributes to include in the
response. This can be used to request fields that are
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/sign_requests.py
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ def create_sign_request(
:param signers: Array of signers for the signature request. 35 is the
max number of signers permitted.

**Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
**Note**: It may happen that some signers belong to conflicting [segments](https://developer.box.com/reference/resources/shield-information-barrier-segment-member) (user groups).
This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
In such a case, an attempt to send the sign request will result in an error.

Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/trashed_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,13 +152,13 @@ def get_trashed_file_by_id(
can be inspected using the


[`GET /folders/:id/trash`](e://get_folders_id_trash) API.
[`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.


To list all items that have been moved to the trash, please


use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)


API.
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/trashed_folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,13 @@ def get_trashed_folder_by_id(
can be inspected using the


[`GET /folders/:id/trash`](e://get_folders_id_trash) API.
[`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.


To list all items that have been moved to the trash, please


use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)


API.
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/zip_downloads.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ def get_zip_download_content(
The URL of this endpoint should not be considered as fixed. Instead, use


the [Create zip download](e://post_zip_downloads) API to request to create a
the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a


`zip` archive, and then follow the `download_url` field in the response to
Expand Down Expand Up @@ -260,7 +260,7 @@ def get_zip_download_status(
The URL of this endpoint should not be considered as fixed. Instead, use


the [Create zip download](e://post_zip_downloads) API to request to create a
the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a


`zip` archive, and then follow the `status_url` field in the response to
Expand Down
Loading
Loading