diff --git a/.codegen.json b/.codegen.json index 53f51ce9..0117aee2 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "c370934", "specHash": "1e0848d", "version": "4.2.0" } +{ "engineHash": "c370934", "specHash": "9d069ca", "version": "4.2.0" } diff --git a/box_sdk_gen/managers/ai.py b/box_sdk_gen/managers/ai.py index 6ac86c88..11b1d6f3 100644 --- a/box_sdk_gen/managers/ai.py +++ b/box_sdk_gen/managers/ai.py @@ -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] diff --git a/box_sdk_gen/managers/archives.py b/box_sdk_gen/managers/archives.py index b6bf5faf..146b58f8 100644 --- a/box_sdk_gen/managers/archives.py +++ b/box_sdk_gen/managers/archives.py @@ -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 @@ -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 @@ -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" @@ -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" diff --git a/box_sdk_gen/managers/chunked_uploads.py b/box_sdk_gen/managers/chunked_uploads.py index 1ff14868..aed8f1fd 100644 --- a/box_sdk_gen/managers/chunked_uploads.py +++ b/box_sdk_gen/managers/chunked_uploads.py @@ -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 @@ -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" @@ -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 @@ -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" @@ -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 @@ -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" @@ -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 @@ -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" @@ -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 @@ -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" diff --git a/box_sdk_gen/managers/file_classifications.py b/box_sdk_gen/managers/file_classifications.py index c38a2bbf..58836c38 100644 --- a/box_sdk_gen/managers/file_classifications.py +++ b/box_sdk_gen/managers/file_classifications.py @@ -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 @@ -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 diff --git a/box_sdk_gen/managers/file_version_retentions.py b/box_sdk_gen/managers/file_version_retentions.py index 8c2ddf75..9598a3dd 100644 --- a/box_sdk_gen/managers/file_version_retentions.py +++ b/box_sdk_gen/managers/file_version_retentions.py @@ -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 @@ -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" diff --git a/box_sdk_gen/managers/files.py b/box_sdk_gen/managers/files.py index b153e2a6..6175976c 100644 --- a/box_sdk_gen/managers/files.py +++ b/box_sdk_gen/managers/files.py @@ -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. diff --git a/box_sdk_gen/managers/folder_classifications.py b/box_sdk_gen/managers/folder_classifications.py index 4192936a..4241588f 100644 --- a/box_sdk_gen/managers/folder_classifications.py +++ b/box_sdk_gen/managers/folder_classifications.py @@ -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 @@ -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 diff --git a/box_sdk_gen/managers/folders.py b/box_sdk_gen/managers/folders.py index 50772507..f7b3e2c3 100644 --- a/box_sdk_gen/managers/folders.py +++ b/box_sdk_gen/managers/folders.py @@ -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. @@ -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 diff --git a/box_sdk_gen/managers/metadata_cascade_policies.py b/box_sdk_gen/managers/metadata_cascade_policies.py index 2d254c87..e6cf0062 100644 --- a/box_sdk_gen/managers/metadata_cascade_policies.py +++ b/box_sdk_gen/managers/metadata_cascade_policies.py @@ -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 diff --git a/box_sdk_gen/managers/search.py b/box_sdk_gen/managers/search.py index f5adde96..dfb1a16d 100644 --- a/box_sdk_gen/managers/search.py +++ b/box_sdk_gen/managers/search.py @@ -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 diff --git a/box_sdk_gen/managers/sign_requests.py b/box_sdk_gen/managers/sign_requests.py index bef15282..75e4cf0e 100644 --- a/box_sdk_gen/managers/sign_requests.py +++ b/box_sdk_gen/managers/sign_requests.py @@ -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. diff --git a/box_sdk_gen/managers/trashed_files.py b/box_sdk_gen/managers/trashed_files.py index 340d93b3..6aa6eddf 100644 --- a/box_sdk_gen/managers/trashed_files.py +++ b/box_sdk_gen/managers/trashed_files.py @@ -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. diff --git a/box_sdk_gen/managers/trashed_folders.py b/box_sdk_gen/managers/trashed_folders.py index b41e66dd..0796cc26 100644 --- a/box_sdk_gen/managers/trashed_folders.py +++ b/box_sdk_gen/managers/trashed_folders.py @@ -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. diff --git a/box_sdk_gen/managers/zip_downloads.py b/box_sdk_gen/managers/zip_downloads.py index 7813cbdc..c056430a 100644 --- a/box_sdk_gen/managers/zip_downloads.py +++ b/box_sdk_gen/managers/zip_downloads.py @@ -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 @@ -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 diff --git a/box_sdk_gen/schemas/ai_agent_basic_gen_tool.py b/box_sdk_gen/schemas/ai_agent_basic_gen_tool.py index 6aef8bb0..2bb60b4e 100644 --- a/box_sdk_gen/schemas/ai_agent_basic_gen_tool.py +++ b/box_sdk_gen/schemas/ai_agent_basic_gen_tool.py @@ -52,7 +52,7 @@ def __init__( When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_basic_text_tool.py b/box_sdk_gen/schemas/ai_agent_basic_text_tool.py index 5c48ae50..f9722bb0 100644 --- a/box_sdk_gen/schemas/ai_agent_basic_text_tool.py +++ b/box_sdk_gen/schemas/ai_agent_basic_text_tool.py @@ -33,7 +33,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_basic_text_tool_base.py b/box_sdk_gen/schemas/ai_agent_basic_text_tool_base.py index 0090d421..e077b03c 100644 --- a/box_sdk_gen/schemas/ai_agent_basic_text_tool_base.py +++ b/box_sdk_gen/schemas/ai_agent_basic_text_tool_base.py @@ -25,7 +25,7 @@ def __init__( **kwargs ): """ - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_basic_text_tool_text_gen.py b/box_sdk_gen/schemas/ai_agent_basic_text_tool_text_gen.py index 2d9a73f0..cc49bd6a 100644 --- a/box_sdk_gen/schemas/ai_agent_basic_text_tool_text_gen.py +++ b/box_sdk_gen/schemas/ai_agent_basic_text_tool_text_gen.py @@ -35,7 +35,7 @@ def __init__( When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_long_text_tool.py b/box_sdk_gen/schemas/ai_agent_long_text_tool.py index 57773078..de45f4b5 100644 --- a/box_sdk_gen/schemas/ai_agent_long_text_tool.py +++ b/box_sdk_gen/schemas/ai_agent_long_text_tool.py @@ -74,7 +74,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_long_text_tool_text_gen.py b/box_sdk_gen/schemas/ai_agent_long_text_tool_text_gen.py index 44516294..b168df4f 100644 --- a/box_sdk_gen/schemas/ai_agent_long_text_tool_text_gen.py +++ b/box_sdk_gen/schemas/ai_agent_long_text_tool_text_gen.py @@ -78,7 +78,7 @@ def __init__( When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_agent_reference.py b/box_sdk_gen/schemas/ai_agent_reference.py index f8b2bb38..9f7dd1dc 100644 --- a/box_sdk_gen/schemas/ai_agent_reference.py +++ b/box_sdk_gen/schemas/ai_agent_reference.py @@ -26,7 +26,7 @@ def __init__( :type type: AiAgentReferenceTypeField, optional :param id: The ID of an Agent. This can be a numeric ID for custom agents (for example, `14031`) or a unique identifier for pre-built agents (for example, `enhanced_extract_agent` - for the [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent))., defaults to None + for the [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent))., defaults to None :type id: Optional[str], optional """ super().__init__(**kwargs) diff --git a/box_sdk_gen/schemas/ai_agent_spreadsheet_tool.py b/box_sdk_gen/schemas/ai_agent_spreadsheet_tool.py index fe794212..1dbb1f49 100644 --- a/box_sdk_gen/schemas/ai_agent_spreadsheet_tool.py +++ b/box_sdk_gen/schemas/ai_agent_spreadsheet_tool.py @@ -25,7 +25,7 @@ def __init__( **kwargs ): """ - :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool.py b/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool.py index b3ed99e0..5e017d11 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool.py +++ b/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool.py @@ -57,7 +57,7 @@ def __init__( When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool_response.py b/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool_response.py index 4e418497..7c006939 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool_response.py +++ b/box_sdk_gen/schemas/ai_studio_agent_basic_gen_tool_response.py @@ -64,7 +64,7 @@ def __init__( When using the `prompt_template` parameter, you **must include** input for `{user_question}`. Inputs for `{current_date}` and `{content}` are optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool.py b/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool.py index bb1435fe..a910fb58 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool.py +++ b/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool.py @@ -38,7 +38,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool_response.py b/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool_response.py index 47b4eaf2..5f5e1a93 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool_response.py +++ b/box_sdk_gen/schemas/ai_studio_agent_basic_text_tool_response.py @@ -47,7 +47,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_long_text_tool.py b/box_sdk_gen/schemas/ai_studio_agent_long_text_tool.py index 5419f0b1..1e31c862 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_long_text_tool.py +++ b/box_sdk_gen/schemas/ai_studio_agent_long_text_tool.py @@ -45,7 +45,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_long_text_tool_response.py b/box_sdk_gen/schemas/ai_studio_agent_long_text_tool_response.py index b521b375..350093ab 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_long_text_tool_response.py +++ b/box_sdk_gen/schemas/ai_studio_agent_long_text_tool_response.py @@ -52,7 +52,7 @@ def __init__( When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use., defaults to None :type prompt_template: Optional[str], optional - :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for basic text. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool.py b/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool.py index 9d207998..c453f3ca 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool.py +++ b/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool.py @@ -25,7 +25,7 @@ def __init__( **kwargs ): """ - :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool_response.py b/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool_response.py index bf632314..888b52cb 100644 --- a/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool_response.py +++ b/box_sdk_gen/schemas/ai_studio_agent_spreadsheet_tool_response.py @@ -34,7 +34,7 @@ def __init__( """ :param warnings: Warnings concerning tool., defaults to None :type warnings: Optional[List[str]], optional - :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](g://box-ai/supported-models)., defaults to None + :param model: The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](https://developer.box.com/guides/box-ai/supported-models)., defaults to None :type model: Optional[str], optional :param num_tokens_for_completion: The number of tokens for completion., defaults to None :type num_tokens_for_completion: Optional[int], optional diff --git a/box_sdk_gen/schemas/metadata_cascade_policy.py b/box_sdk_gen/schemas/metadata_cascade_policy.py index a3096866..d24ce599 100644 --- a/box_sdk_gen/schemas/metadata_cascade_policy.py +++ b/box_sdk_gen/schemas/metadata_cascade_policy.py @@ -112,9 +112,9 @@ def __init__( 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, defaults to None + [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, defaults to None :type template_key: Optional[str], optional """ super().__init__(**kwargs) diff --git a/box_sdk_gen/schemas/metadata_filter.py b/box_sdk_gen/schemas/metadata_filter.py index e25881cf..2f0fb266 100644 --- a/box_sdk_gen/schemas/metadata_filter.py +++ b/box_sdk_gen/schemas/metadata_filter.py @@ -61,9 +61,9 @@ def __init__( 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, defaults to None + [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, defaults to None :type template_key: Optional[str], optional :param filters: Specifies which fields on the template to filter the search results by. When more than one field is specified, the query diff --git a/box_sdk_gen/schemas/sign_request_create_request.py b/box_sdk_gen/schemas/sign_request_create_request.py index 8d18ce00..7222098a 100644 --- a/box_sdk_gen/schemas/sign_request_create_request.py +++ b/box_sdk_gen/schemas/sign_request_create_request.py @@ -50,7 +50,7 @@ def __init__( :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. diff --git a/box_sdk_gen/schemas/sign_template.py b/box_sdk_gen/schemas/sign_template.py index 08f7ca68..f96b30ca 100644 --- a/box_sdk_gen/schemas/sign_template.py +++ b/box_sdk_gen/schemas/sign_template.py @@ -208,7 +208,7 @@ def __init__( :type are_files_locked: Optional[bool], optional :param signers: Array of signers for the template. - **Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups). + **Note**: It may happen that some signers specified in the template 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 a sign request based on a template that lists signers in conflicting segments will result in an error. diff --git a/docs/box_sdk_gen/ai.md b/docs/box_sdk_gen/ai.md index bd4ceff9..47ab0f5b 100644 --- a/docs/box_sdk_gen/ai.md +++ b/docs/box_sdk_gen/ai.md @@ -153,11 +153,11 @@ A response including the answer from the LLM. Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. 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. This operation is performed by calling function `create_ai_extract_structured`. diff --git a/docs/box_sdk_gen/archives.md b/docs/box_sdk_gen/archives.md index fe1c26bd..23ef1405 100644 --- a/docs/box_sdk_gen/archives.md +++ b/docs/box_sdk_gen/archives.md @@ -9,7 +9,7 @@ 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). This operation is performed by calling function `get_archives_v2025_r0`. @@ -43,7 +43,7 @@ Returns a list of archives in the enterprise. 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). This operation is performed by calling function `create_archive_v2025_r0`. @@ -79,7 +79,7 @@ Returns a new archive object. 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). This operation is performed by calling function `delete_archive_by_id_v2025_r0`. @@ -111,7 +111,7 @@ Returns an empty response when the archive has been deleted. 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). This operation is performed by calling function `update_archive_by_id_v2025_r0`. diff --git a/docs/box_sdk_gen/chunked_uploads.md b/docs/box_sdk_gen/chunked_uploads.md index 002edb0b..1e696824 100644 --- a/docs/box_sdk_gen/chunked_uploads.md +++ b/docs/box_sdk_gen/chunked_uploads.md @@ -80,7 +80,7 @@ Returns a new upload session. 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. This operation is performed by calling function `get_file_upload_session_by_url`. @@ -110,7 +110,7 @@ Returns an upload session object. 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. This operation is performed by calling function `get_file_upload_session_by_id`. @@ -140,8 +140,8 @@ Returns an upload session object. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `upload_file_part_by_url`. @@ -177,8 +177,8 @@ Chunk has been uploaded successfully. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `upload_file_part`. @@ -216,8 +216,8 @@ Abort an upload session and discard all data uploaded. This cannot be reversed. -The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `delete_file_upload_session_by_url`. @@ -250,8 +250,8 @@ Abort an upload session and discard all data uploaded. This cannot be reversed. -The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `delete_file_upload_session_by_id`. @@ -282,8 +282,8 @@ successfully aborted. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `get_file_upload_session_parts_by_url`. @@ -317,8 +317,8 @@ Returns a list of parts that have been uploaded. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `get_file_upload_session_parts`. @@ -352,8 +352,8 @@ Returns a list of parts that have been uploaded. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `create_file_upload_session_commit_by_url`. @@ -395,8 +395,8 @@ when all chunks have processed. 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) -and [`Get upload session`](e://get-files-upload-sessions-id) endpoints. +The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) +and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints. This operation is performed by calling function `create_file_upload_session_commit`. diff --git a/docs/box_sdk_gen/downloads.md b/docs/box_sdk_gen/downloads.md index 46ea036e..c8be4bd8 100644 --- a/docs/box_sdk_gen/downloads.md +++ b/docs/box_sdk_gen/downloads.md @@ -43,7 +43,7 @@ redirects** setting enabled to automatically follow HTTP `3xx` responses as redirects. If not, the request will return `302` instead. For details, see -the [download file guide](g://downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will +the [download file guide](https://developer.box.com/guides/downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will be returned indicating the time in seconds after which the file will be available for the client to download. @@ -89,7 +89,7 @@ redirects** setting enabled to automatically follow HTTP `3xx` responses as redirects. If not, the request will return `302` instead. For details, see -the [download file guide](g://downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will +the [download file guide](https://developer.box.com/guides/downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will be returned indicating the time in seconds after which the file will be available for the client to download. diff --git a/docs/box_sdk_gen/file_classifications.md b/docs/box_sdk_gen/file_classifications.md index bb212797..1a1448c1 100644 --- a/docs/box_sdk_gen/file_classifications.md +++ b/docs/box_sdk_gen/file_classifications.md @@ -66,7 +66,7 @@ client.file_classifications.add_classification_to_file(file.id, box_security_cla - file_id `str` - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" - box_security_classification_key `Optional[str]` - - The name of the classification to apply to this 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) which lists all available classification keys. + - The name of the classification to apply to this file. To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/box_sdk_gen/file_version_retentions.md b/docs/box_sdk_gen/file_version_retentions.md index 10fd3a7f..2f4c22d4 100644 --- a/docs/box_sdk_gen/file_version_retentions.md +++ b/docs/box_sdk_gen/file_version_retentions.md @@ -10,7 +10,7 @@ Retrieves all file version retentions for the given enterprise. **Note**: File retention API is now **deprecated**. 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. This operation is performed by calling function `get_file_version_retentions`. @@ -57,7 +57,7 @@ Returns information about a file version retention. **Note**: File retention API is now **deprecated**. 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. This operation is performed by calling function `get_file_version_retention_by_id`. diff --git a/docs/box_sdk_gen/files.md b/docs/box_sdk_gen/files.md index b8b24dd7..41317db8 100644 --- a/docs/box_sdk_gen/files.md +++ b/docs/box_sdk_gen/files.md @@ -80,7 +80,7 @@ client.files.update_file_by_id(file_to_update.id, name=updated_name, description - permissions `Optional[UpdateFileByIdPermissions]` - Defines who can download a file. - collections `Optional[List[UpdateFileByIdCollections]]` - - An array of collections to make this file a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the file from all collections. [1]: e://get-collections + - An array of collections to make this file a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the file from all collections. [1]: https://developer.box.com/reference/get-collections - tags `Optional[List[str]]` - The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item's current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise. - fields `Optional[List[str]]` diff --git a/docs/box_sdk_gen/folder_classifications.md b/docs/box_sdk_gen/folder_classifications.md index 2ae592e5..a996158d 100644 --- a/docs/box_sdk_gen/folder_classifications.md +++ b/docs/box_sdk_gen/folder_classifications.md @@ -66,7 +66,7 @@ client.folder_classifications.add_classification_to_folder(folder.id, box_securi - folder_id `str` - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" - box_security_classification_key `Optional[str]` - - The name of the classification to apply to this 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) which lists all available classification keys. + - The name of the classification to apply to this folder. To list the available classifications in an enterprise, use the classification API to retrieve the [classification template](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema) which lists all available classification keys. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/box_sdk_gen/folders.md b/docs/box_sdk_gen/folders.md index 48be00d5..27c8a306 100644 --- a/docs/box_sdk_gen/folders.md +++ b/docs/box_sdk_gen/folders.md @@ -15,10 +15,10 @@ in the folder. Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the 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. This operation is performed by calling function `get_folder_by_id`. @@ -62,7 +62,7 @@ If you used query parameters like the _folder items list_ will be affected accordingly. 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. Not all available fields are returned by default. Use the [fields](#param-fields) query parameter to explicitly request @@ -104,7 +104,7 @@ client.folders.update_folder_by_id(folder_to_update.id, name=updated_name, descr - is_collaboration_restricted_to_enterprise `Optional[bool]` - Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations. - collections `Optional[List[UpdateFolderByIdCollections]]` - - An array of collections to make this folder a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the folder from all collections. [1]: e://get-collections + - An array of collections to make this folder a member of. Currently we only support the `favorites` collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array `[]` or `null` will remove the folder from all collections. [1]: https://developer.box.com/reference/get-collections - can_non_owners_view_collaborators `Optional[bool]` - Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder. It also restricts non-owners from inviting new collaborators. When setting this field to `false`, it is required to also set `can_non_owners_invite_collaborators` to `false` if it has not already been set. - fields `Optional[List[str]]` diff --git a/docs/box_sdk_gen/metadata_cascade_policies.md b/docs/box_sdk_gen/metadata_cascade_policies.md index 7e91d836..7b7d16d8 100644 --- a/docs/box_sdk_gen/metadata_cascade_policies.md +++ b/docs/box_sdk_gen/metadata_cascade_policies.md @@ -69,7 +69,7 @@ client.metadata_cascade_policies.create_metadata_cascade_policy(folder.id, Creat - scope `CreateMetadataCascadePolicyScope` - The scope of the targeted metadata template. This template will need to already have an instance applied to the targeted folder. - template_key `str` - - The key of the targeted metadata template. This template will need to already have an instance applied to the targeted folder. In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key. Please [list the templates for an enterprise][list], or 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 + - The key of the targeted metadata template. This template will need to already have an instance applied to the targeted folder. In many cases the template key is automatically derived of its display name, for example `Contract Template` would become `contractTemplate`. In some cases the creator of the template will have provided its own template key. Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template's key. [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 - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/box_sdk_gen/search.md b/docs/box_sdk_gen/search.md index bb62925e..25f0ebda 100644 --- a/docs/box_sdk_gen/search.md +++ b/docs/box_sdk_gen/search.md @@ -101,7 +101,7 @@ client.search.search_for_content(ancestor_folder_ids=['0'], mdfilters=[MetadataF - limit `Optional[int]` - Defines the maximum number of items to return as part of a page of results. - include_recent_shared_links `Optional[bool]` - - Defines whether the search results should include any items that the user recently accessed through a shared link. 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). + - Defines whether the search results should include any items that the user recently accessed through a shared link. 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](https://developer.box.com/reference/resources/search-results-with-shared-links). - fields `Optional[List[str]]` - A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. - offset `Optional[int]` diff --git a/docs/box_sdk_gen/sign_requests.md b/docs/box_sdk_gen/sign_requests.md index db72e304..bd51bb19 100644 --- a/docs/box_sdk_gen/sign_requests.md +++ b/docs/box_sdk_gen/sign_requests.md @@ -145,7 +145,7 @@ client.sign_requests.create_sign_request([SignRequestCreateSigner(email=signer_e - signature_color `Optional[CreateSignRequestSignatureColor]` - Force a specific color for the signature (blue, black, or red). - signers `List[SignRequestCreateSigner]` - - 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). 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. Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ). + - 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](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. Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ). - parent_folder `Optional[FolderMini]` - is_document_preparation_needed `Optional[bool]` - Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI. diff --git a/docs/box_sdk_gen/trashed_files.md b/docs/box_sdk_gen/trashed_files.md index 3b77196f..0afadfa8 100644 --- a/docs/box_sdk_gen/trashed_files.md +++ b/docs/box_sdk_gen/trashed_files.md @@ -48,10 +48,10 @@ Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder 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. This operation is performed by calling function `get_trashed_file_by_id`. diff --git a/docs/box_sdk_gen/trashed_folders.md b/docs/box_sdk_gen/trashed_folders.md index 66a0f27f..8be20350 100644 --- a/docs/box_sdk_gen/trashed_folders.md +++ b/docs/box_sdk_gen/trashed_folders.md @@ -55,10 +55,10 @@ Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder 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. This operation is performed by calling function `get_trashed_folder_by_id`. diff --git a/docs/box_sdk_gen/zip_downloads.md b/docs/box_sdk_gen/zip_downloads.md index ee24a62b..79d3f36e 100644 --- a/docs/box_sdk_gen/zip_downloads.md +++ b/docs/box_sdk_gen/zip_downloads.md @@ -64,7 +64,7 @@ stopped and resumed, instead a new request for a zip archive would need to be created. 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 this endpoint. @@ -104,7 +104,7 @@ Subsequently this endpoint is valid for 12 hours from the start of the download. 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 this endpoint.