From 43c2af6e22fa547abbd8ac7c177a5fa7280a3d6f Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Fri, 12 Jun 2026 01:52:36 -0700 Subject: [PATCH 1/4] chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci] --- .codegen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index 7756a89b..0cde6380 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "e392e8c", "specHash": "dd7f7a9", "version": "10.12.0" } +{ "engineHash": "b29f419", "specHash": "dd7f7a9", "version": "10.12.0" } From a4abcc3136a26d7bea74d4c69f7b0201be3e7e7b Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Thu, 25 Jun 2026 11:49:11 -0700 Subject: [PATCH 2/4] feat: add direct link to search files by keywords results [PARTNERS-44231] (box/box-codegen#963) --- .codegen.json | 2 +- .github/workflows/fossa.yml | 30 ------------------------------ 2 files changed, 1 insertion(+), 31 deletions(-) delete mode 100644 .github/workflows/fossa.yml diff --git a/.codegen.json b/.codegen.json index 0cde6380..58641d45 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "b29f419", "specHash": "dd7f7a9", "version": "10.12.0" } +{ "engineHash": "6f9492d", "specHash": "dd7f7a9", "version": "10.12.0" } diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml deleted file mode 100644 index 01efe1db..00000000 --- a/.github/workflows/fossa.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: FOSSA Scan - -on: - push: - branches: [main, combined-sdk] - pull_request: - branches: [main, combined-sdk] - -permissions: - contents: read - -jobs: - fossa: - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install -e .[dev] - - uses: fossas/fossa-action@main - with: - api-key: ${{ secrets.FOSSA_API_KEY }} - branch: ${{ github.head_ref || github.ref_name }} From 2cc4477c4683d4b36f2dfe9205acbd443a02d096 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 29 Jun 2026 06:19:18 -0700 Subject: [PATCH 3/4] docs: (DDOC-1751) Surfaced AI Hubs functionality (box/box-openapi#606) --- .codegen.json | 2 +- box_sdk_gen/managers/ai.py | 9 +++ box_sdk_gen/managers/hubs.py | 24 +++++++- box_sdk_gen/managers/sign_requests.py | 5 ++ box_sdk_gen/schemas/ai_ask.py | 3 + box_sdk_gen/schemas/ai_item_ask.py | 14 +++-- box_sdk_gen/schemas/sign_request.py | 5 ++ box_sdk_gen/schemas/sign_request_base.py | 57 ++++++++++--------- .../schemas/sign_request_create_request.py | 5 ++ .../schemas/sign_request_signer_input.py | 11 ++++ box_sdk_gen/schemas/sign_template.py | 4 ++ .../v2025_r0/hub_copy_request_v2025_r0.py | 13 +++-- .../v2025_r0/hub_update_request_v2025_r0.py | 44 +++++++++----- box_sdk_gen/schemas/v2025_r0/hub_v2025_r0.py | 16 ++++++ docs/ai.md | 10 +++- docs/ai_studio.md | 6 ++ docs/avatars.md | 2 + docs/chunked_uploads.md | 4 +- docs/docgen.md | 4 ++ docs/docgen_template.md | 1 + docs/events.md | 4 +- docs/files.md | 2 + docs/folders.md | 8 ++- docs/groups.md | 4 +- docs/hubs.md | 4 ++ docs/integration_mappings.md | 8 +++ docs/metadata_cascade_policies.md | 2 +- docs/notes.md | 1 + docs/retention_policies.md | 6 +- docs/search.md | 14 ++--- docs/shield_information_barrier_reports.md | 1 + ...eld_information_barrier_segment_members.md | 1 + ...nformation_barrier_segment_restrictions.md | 1 + docs/shield_information_barrier_segments.md | 1 + docs/shield_lists.md | 2 + docs/sign_requests.md | 3 + docs/task_assignments.md | 2 +- docs/tasks.md | 8 +-- docs/trashed_files.md | 1 + docs/trashed_folders.md | 1 + docs/trashed_web_links.md | 1 + docs/uploads.md | 8 +++ docs/users.md | 2 +- docs/web_links.md | 1 + 44 files changed, 248 insertions(+), 77 deletions(-) diff --git a/.codegen.json b/.codegen.json index 58641d45..1947d1b9 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "6f9492d", "specHash": "dd7f7a9", "version": "10.12.0" } +{ "engineHash": "6f9492d", "specHash": "131c54a", "version": "10.12.0" } diff --git a/box_sdk_gen/managers/ai.py b/box_sdk_gen/managers/ai.py index aafc29b3..0e3926a0 100644 --- a/box_sdk_gen/managers/ai.py +++ b/box_sdk_gen/managers/ai.py @@ -259,6 +259,12 @@ def create_ai_ask( ) -> Optional[AiResponseFull]: """ Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. + + You can ask a question about a single file, several files, or the entire contents of a Box Hub. To search across and ask questions about everything in a Box Hub, send a single item with `type` set to `hubs` and the Hub's ID as the `id`. Box AI answers the question using the indexed content of all files in that Hub. + + + Asking questions about a Box Hub requires Box AI for Hubs to be enabled in the Admin Console before the Hub is created, so that its content is indexed. + :param mode: Box AI handles text documents with text representations up to 2MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 2MB, the first 2MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages @@ -271,6 +277,9 @@ def create_ai_ask( The prompt's length is limited to 10000 characters. :type prompt: str :param items: The items to be processed by the LLM, often files. + To search across and ask questions about the contents of a Box Hub, + pass a single item with `type` set to `hubs`. See the item `type` + property for details. :type items: List[AiItemAsk] :param dialogue_history: The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response., defaults to None :type dialogue_history: Optional[List[AiDialogueHistory]], optional diff --git a/box_sdk_gen/managers/hubs.py b/box_sdk_gen/managers/hubs.py index 26e34bca..a919678a 100644 --- a/box_sdk_gen/managers/hubs.py +++ b/box_sdk_gen/managers/hubs.py @@ -63,6 +63,12 @@ class GetEnterpriseHubsV2025R0Direction(str, Enum): DESC = 'DESC' +class UpdateHubByIdV2025R0CopyHubAccess(str, Enum): + ALL = 'all' + COMPANY = 'company' + NONE = 'none' + + class HubsManager: def __init__( self, @@ -304,6 +310,7 @@ def update_hub_by_id_v2025_r0( can_non_owners_invite: Optional[bool] = None, can_shared_link_be_created: Optional[bool] = None, can_public_shared_link_be_created: Optional[bool] = None, + copy_hub_access: Optional[UpdateHubByIdV2025R0CopyHubAccess] = None, box_version: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._2025_0, extra_headers: Optional[Dict[str, Optional[str]]] = None ) -> HubV2025R0: @@ -332,6 +339,12 @@ def update_hub_by_id_v2025_r0( :type can_shared_link_be_created: Optional[bool], optional :param can_public_shared_link_be_created: Indicates if a public shared link can be created for the Box Hub., defaults to None :type can_public_shared_link_be_created: Optional[bool], optional + :param copy_hub_access: Specifies who is allowed to copy the Box Hub. + + * `all` - Any user with access to the Hub can copy it. + * `company` - Only users within the same enterprise as the Hub can copy it. + * `none` - No one can copy the Hub., defaults to None + :type copy_hub_access: Optional[UpdateHubByIdV2025R0CopyHubAccess], optional :param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0 :type box_version: BoxVersionHeaderV2025R0, optional :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None @@ -349,6 +362,7 @@ def update_hub_by_id_v2025_r0( 'can_non_owners_invite': can_non_owners_invite, 'can_shared_link_be_created': can_shared_link_be_created, 'can_public_shared_link_be_created': can_public_shared_link_be_created, + 'copy_hub_access': copy_hub_access, } headers_map: Dict[str, str] = prepare_params( {'box-version': to_string(box_version), **extra_headers} @@ -425,6 +439,7 @@ def copy_hub_v2025_r0( *, title: Optional[str] = None, description: Optional[str] = None, + include_items: Optional[bool] = None, box_version: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._2025_0, extra_headers: Optional[Dict[str, Optional[str]]] = None ) -> HubV2025R0: @@ -446,6 +461,9 @@ def copy_hub_v2025_r0( :type title: Optional[str], optional :param description: Description of the Box Hub., defaults to None :type description: Optional[str], optional + :param include_items: If true, the items which the user has Editor or Owner access to in the original Box Hub will be copied to the new Box Hub. + Defaults to false., defaults to None + :type include_items: Optional[bool], optional :param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0 :type box_version: BoxVersionHeaderV2025R0, optional :param extra_headers: Extra headers that will be included in the HTTP request., defaults to None @@ -453,7 +471,11 @@ def copy_hub_v2025_r0( """ if extra_headers is None: extra_headers = {} - request_body: Dict = {'title': title, 'description': description} + request_body: Dict = { + 'title': title, + 'description': description, + 'include_items': include_items, + } headers_map: Dict[str, str] = prepare_params( {'box-version': to_string(box_version), **extra_headers} ) diff --git a/box_sdk_gen/managers/sign_requests.py b/box_sdk_gen/managers/sign_requests.py index 09e00bf5..cc1dffd7 100644 --- a/box_sdk_gen/managers/sign_requests.py +++ b/box_sdk_gen/managers/sign_requests.py @@ -268,6 +268,7 @@ def create_sign_request( external_id: Union[Optional[str], NullValue] = None, template_id: Union[Optional[str], NullValue] = None, external_system_name: Union[Optional[str], NullValue] = None, + request_flow: Union[Optional[str], NullValue] = None, extra_headers: Optional[Dict[str, Optional[str]]] = None ) -> SignRequest: """ @@ -314,6 +315,9 @@ def create_sign_request( :type template_id: Union[Optional[str], NullValue], optional :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None :type external_system_name: Union[Optional[str], NullValue], optional + :param request_flow: The flow type of the sign request. Values can include `standard` or `cfr11`. + When not specified during creation, a default is chosen based on admin settings., defaults to None + :type request_flow: Union[Optional[str], NullValue], optional :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 """ @@ -337,6 +341,7 @@ def create_sign_request( 'external_id': external_id, 'template_id': template_id, 'external_system_name': external_system_name, + 'request_flow': request_flow, } headers_map: Dict[str, str] = prepare_params({**extra_headers}) response: FetchResponse = self.network_session.network_client.fetch( diff --git a/box_sdk_gen/schemas/ai_ask.py b/box_sdk_gen/schemas/ai_ask.py index 74c9f7b1..9ab0ee95 100644 --- a/box_sdk_gen/schemas/ai_ask.py +++ b/box_sdk_gen/schemas/ai_ask.py @@ -49,6 +49,9 @@ def __init__( The prompt's length is limited to 10000 characters. :type prompt: str :param items: The items to be processed by the LLM, often files. + To search across and ask questions about the contents of a Box Hub, + pass a single item with `type` set to `hubs`. See the item `type` + property for details. :type items: List[AiItemAsk] :param dialogue_history: The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response., defaults to None :type dialogue_history: Optional[List[AiDialogueHistory]], optional diff --git a/box_sdk_gen/schemas/ai_item_ask.py b/box_sdk_gen/schemas/ai_item_ask.py index d2702b88..b0c3f8bd 100644 --- a/box_sdk_gen/schemas/ai_item_ask.py +++ b/box_sdk_gen/schemas/ai_item_ask.py @@ -24,12 +24,14 @@ def __init__( **kwargs ): """ - :param id: The ID of the file. - :type id: str - :param type: The type of the item. A `hubs` item must be used as a single item. - :type type: AiItemAskTypeField - :param content: The content of the item, often the text representation., defaults to None - :type content: Optional[str], optional + :param id: The ID of the file, or the ID of the Box Hub when `type` is `hubs`. + :type id: str + :param type: The type of the item. Use `file` to ask a question about a file, or `hubs` to + search across and ask a question about the entire contents of a Box Hub. + A `hubs` item must be the only item in the request. + :type type: AiItemAskTypeField + :param content: The content of the item, often the text representation., defaults to None + :type content: Optional[str], optional """ super().__init__(**kwargs) self.id = id diff --git a/box_sdk_gen/schemas/sign_request.py b/box_sdk_gen/schemas/sign_request.py index be46f126..1cdf3503 100644 --- a/box_sdk_gen/schemas/sign_request.py +++ b/box_sdk_gen/schemas/sign_request.py @@ -101,6 +101,7 @@ def __init__( external_id: Optional[str] = None, template_id: Optional[str] = None, external_system_name: Optional[str] = None, + request_flow: Optional[str] = None, **kwargs ): """ @@ -170,6 +171,9 @@ def __init__( :type template_id: Optional[str], optional :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None :type external_system_name: Optional[str], optional + :param request_flow: The flow type of the sign request. Values can include `standard` or `cfr11`. + When not specified during creation, a default is chosen based on admin settings., defaults to None + :type request_flow: Optional[str], optional """ super().__init__( is_document_preparation_needed=is_document_preparation_needed, @@ -185,6 +189,7 @@ def __init__( external_id=external_id, template_id=template_id, external_system_name=external_system_name, + request_flow=request_flow, **kwargs ) self.type = type diff --git a/box_sdk_gen/schemas/sign_request_base.py b/box_sdk_gen/schemas/sign_request_base.py index 181c9724..abad716d 100644 --- a/box_sdk_gen/schemas/sign_request_base.py +++ b/box_sdk_gen/schemas/sign_request_base.py @@ -26,35 +26,39 @@ def __init__( external_id: Optional[str] = None, template_id: Optional[str] = None, external_system_name: Optional[str] = None, + request_flow: Optional[str] = None, **kwargs ): """ - :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None - :type is_document_preparation_needed: Optional[bool], optional - :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None - :type redirect_url: Optional[str], optional - :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None - :type declined_redirect_url: Optional[str], optional - :param are_text_signatures_enabled: Disables the usage of signatures generated by typing (text)., defaults to None - :type are_text_signatures_enabled: Optional[bool], optional - :param email_subject: Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used., defaults to None - :type email_subject: Optional[str], optional - :param email_message: Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used., defaults to None - :type email_message: Optional[str], optional - :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None - :type are_reminders_enabled: Optional[bool], optional - :param name: Name of the signature request., defaults to None - :type name: Optional[str], optional - :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None - :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional - :param days_valid: Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire., defaults to None - :type days_valid: Optional[int], optional - :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None - :type external_id: Optional[str], optional - :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None - :type template_id: Optional[str], optional - :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None - :type external_system_name: Optional[str], optional + :param is_document_preparation_needed: Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI., defaults to None + :type is_document_preparation_needed: Optional[bool], optional + :param redirect_url: When specified, the signature request will be redirected to this url when a document is signed., defaults to None + :type redirect_url: Optional[str], optional + :param declined_redirect_url: The uri that a signer will be redirected to after declining to sign a document., defaults to None + :type declined_redirect_url: Optional[str], optional + :param are_text_signatures_enabled: Disables the usage of signatures generated by typing (text)., defaults to None + :type are_text_signatures_enabled: Optional[bool], optional + :param email_subject: Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used., defaults to None + :type email_subject: Optional[str], optional + :param email_message: Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used., defaults to None + :type email_message: Optional[str], optional + :param are_reminders_enabled: Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers., defaults to None + :type are_reminders_enabled: Optional[bool], optional + :param name: Name of the signature request., defaults to None + :type name: Optional[str], optional + :param prefill_tags: When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag., defaults to None + :type prefill_tags: Optional[List[SignRequestPrefillTag]], optional + :param days_valid: Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire., defaults to None + :type days_valid: Optional[int], optional + :param external_id: This can be used to reference an ID in an external system that the sign request is related to., defaults to None + :type external_id: Optional[str], optional + :param template_id: When a signature request is created from a template this field will indicate the id of that template., defaults to None + :type template_id: Optional[str], optional + :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None + :type external_system_name: Optional[str], optional + :param request_flow: The flow type of the sign request. Values can include `standard` or `cfr11`. + When not specified during creation, a default is chosen based on admin settings., defaults to None + :type request_flow: Optional[str], optional """ super().__init__(**kwargs) self.is_document_preparation_needed = is_document_preparation_needed @@ -70,3 +74,4 @@ def __init__( self.external_id = external_id self.template_id = template_id self.external_system_name = external_system_name + self.request_flow = request_flow diff --git a/box_sdk_gen/schemas/sign_request_create_request.py b/box_sdk_gen/schemas/sign_request_create_request.py index 7222098a..a1d53a5c 100644 --- a/box_sdk_gen/schemas/sign_request_create_request.py +++ b/box_sdk_gen/schemas/sign_request_create_request.py @@ -44,6 +44,7 @@ def __init__( external_id: Optional[str] = None, template_id: Optional[str] = None, external_system_name: Optional[str] = None, + request_flow: Optional[str] = None, **kwargs ): """ @@ -86,6 +87,9 @@ def __init__( :type template_id: Optional[str], optional :param external_system_name: Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`., defaults to None :type external_system_name: Optional[str], optional + :param request_flow: The flow type of the sign request. Values can include `standard` or `cfr11`. + When not specified during creation, a default is chosen based on admin settings., defaults to None + :type request_flow: Optional[str], optional """ super().__init__( is_document_preparation_needed=is_document_preparation_needed, @@ -101,6 +105,7 @@ def __init__( external_id=external_id, template_id=template_id, external_system_name=external_system_name, + request_flow=request_flow, **kwargs ) self.signers = signers diff --git a/box_sdk_gen/schemas/sign_request_signer_input.py b/box_sdk_gen/schemas/sign_request_signer_input.py index ffb7b1a1..ca2b8d66 100644 --- a/box_sdk_gen/schemas/sign_request_signer_input.py +++ b/box_sdk_gen/schemas/sign_request_signer_input.py @@ -102,6 +102,8 @@ def __init__( content_type: Optional[SignRequestSignerInputContentTypeField] = None, read_only: Optional[bool] = None, validation: Optional[SignRequestSignerInputValidation] = None, + reason: Optional[str] = None, + is_validated: Optional[bool] = None, document_tag_id: Optional[str] = None, text_value: Optional[str] = None, checkbox_value: Optional[bool] = None, @@ -120,6 +122,13 @@ def __init__( :param validation: Specifies the formatting rules that signers must follow for text field inputs. If set, this validation is mandatory., defaults to None :type validation: Optional[SignRequestSignerInputValidation], optional + :param reason: The reason for the signer's input, applicable to signature or initial content types + in a `cfr11` request flow. The value is `null` when not applicable., defaults to None + :type reason: Optional[str], optional + :param is_validated: Indicates whether the signer's input has been validated through re-authentication. + Applicable only for signature or initial content types in a `cfr11` request flow. + The value is `null` for standard request flows or non-applicable input types., defaults to None + :type is_validated: Optional[bool], optional :param document_tag_id: This references the ID of a specific tag contained in a file of the signature request., defaults to None :type document_tag_id: Optional[str], optional :param text_value: Text prefill value., defaults to None @@ -141,3 +150,5 @@ def __init__( self.content_type = content_type self.read_only = read_only self.validation = validation + self.reason = reason + self.is_validated = is_validated diff --git a/box_sdk_gen/schemas/sign_template.py b/box_sdk_gen/schemas/sign_template.py index f96b30ca..55d60fa5 100644 --- a/box_sdk_gen/schemas/sign_template.py +++ b/box_sdk_gen/schemas/sign_template.py @@ -158,6 +158,7 @@ def __init__( additional_info: Optional[SignTemplateAdditionalInfoField] = None, ready_sign_link: Optional[SignTemplateReadySignLinkField] = None, custom_branding: Optional[SignTemplateCustomBrandingField] = None, + request_flow: Optional[str] = None, **kwargs ): """ @@ -230,6 +231,8 @@ def __init__( :param custom_branding: Custom branding applied to notifications and signature requests., defaults to None :type custom_branding: Optional[SignTemplateCustomBrandingField], optional + :param request_flow: The sign flow of sign requests created from the template. Values can include `standard` or `cfr11`., defaults to None + :type request_flow: Optional[str], optional """ super().__init__(**kwargs) self.type = type @@ -249,3 +252,4 @@ def __init__( self.additional_info = additional_info self.ready_sign_link = ready_sign_link self.custom_branding = custom_branding + self.request_flow = request_flow diff --git a/box_sdk_gen/schemas/v2025_r0/hub_copy_request_v2025_r0.py b/box_sdk_gen/schemas/v2025_r0/hub_copy_request_v2025_r0.py index a3926a9a..0788c13e 100644 --- a/box_sdk_gen/schemas/v2025_r0/hub_copy_request_v2025_r0.py +++ b/box_sdk_gen/schemas/v2025_r0/hub_copy_request_v2025_r0.py @@ -11,14 +11,19 @@ def __init__( *, title: Optional[str] = None, description: Optional[str] = None, + include_items: Optional[bool] = None, **kwargs ): """ - :param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None - :type title: Optional[str], optional - :param description: Description of the Box Hub., defaults to None - :type description: Optional[str], optional + :param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None + :type title: Optional[str], optional + :param description: Description of the Box Hub., defaults to None + :type description: Optional[str], optional + :param include_items: If true, the items which the user has Editor or Owner access to in the original Box Hub will be copied to the new Box Hub. + Defaults to false., defaults to None + :type include_items: Optional[bool], optional """ super().__init__(**kwargs) self.title = title self.description = description + self.include_items = include_items diff --git a/box_sdk_gen/schemas/v2025_r0/hub_update_request_v2025_r0.py b/box_sdk_gen/schemas/v2025_r0/hub_update_request_v2025_r0.py index cf120b7c..edaf8889 100644 --- a/box_sdk_gen/schemas/v2025_r0/hub_update_request_v2025_r0.py +++ b/box_sdk_gen/schemas/v2025_r0/hub_update_request_v2025_r0.py @@ -1,3 +1,5 @@ +from enum import Enum + from typing import Optional from box_sdk_gen.internal.base_object import BaseObject @@ -5,6 +7,12 @@ from box_sdk_gen.box.errors import BoxSDKError +class HubUpdateRequestV2025R0CopyHubAccessField(str, Enum): + ALL = 'all' + COMPANY = 'company' + NONE = 'none' + + class HubUpdateRequestV2025R0(BaseObject): def __init__( self, @@ -16,23 +24,30 @@ def __init__( can_non_owners_invite: Optional[bool] = None, can_shared_link_be_created: Optional[bool] = None, can_public_shared_link_be_created: Optional[bool] = None, + copy_hub_access: Optional[HubUpdateRequestV2025R0CopyHubAccessField] = None, **kwargs ): """ - :param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None - :type title: Optional[str], optional - :param description: Description of the Box Hub., defaults to None - :type description: Optional[str], optional - :param is_ai_enabled: Indicates if AI features are enabled for the Box Hub., defaults to None - :type is_ai_enabled: Optional[bool], optional - :param is_collaboration_restricted_to_enterprise: Indicates if collaboration is restricted to the enterprise., defaults to None - :type is_collaboration_restricted_to_enterprise: Optional[bool], optional - :param can_non_owners_invite: Indicates if non-owners can invite others to the Box Hub., defaults to None - :type can_non_owners_invite: Optional[bool], optional - :param can_shared_link_be_created: Indicates if a shared link can be created for the Box Hub., defaults to None - :type can_shared_link_be_created: Optional[bool], optional - :param can_public_shared_link_be_created: Indicates if a public shared link can be created for the Box Hub., defaults to None - :type can_public_shared_link_be_created: Optional[bool], optional + :param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None + :type title: Optional[str], optional + :param description: Description of the Box Hub., defaults to None + :type description: Optional[str], optional + :param is_ai_enabled: Indicates if AI features are enabled for the Box Hub., defaults to None + :type is_ai_enabled: Optional[bool], optional + :param is_collaboration_restricted_to_enterprise: Indicates if collaboration is restricted to the enterprise., defaults to None + :type is_collaboration_restricted_to_enterprise: Optional[bool], optional + :param can_non_owners_invite: Indicates if non-owners can invite others to the Box Hub., defaults to None + :type can_non_owners_invite: Optional[bool], optional + :param can_shared_link_be_created: Indicates if a shared link can be created for the Box Hub., defaults to None + :type can_shared_link_be_created: Optional[bool], optional + :param can_public_shared_link_be_created: Indicates if a public shared link can be created for the Box Hub., defaults to None + :type can_public_shared_link_be_created: Optional[bool], optional + :param copy_hub_access: Specifies who is allowed to copy the Box Hub. + + * `all` - Any user with access to the Hub can copy it. + * `company` - Only users within the same enterprise as the Hub can copy it. + * `none` - No one can copy the Hub., defaults to None + :type copy_hub_access: Optional[HubUpdateRequestV2025R0CopyHubAccessField], optional """ super().__init__(**kwargs) self.title = title @@ -44,3 +59,4 @@ def __init__( self.can_non_owners_invite = can_non_owners_invite self.can_shared_link_be_created = can_shared_link_be_created self.can_public_shared_link_be_created = can_public_shared_link_be_created + self.copy_hub_access = copy_hub_access diff --git a/box_sdk_gen/schemas/v2025_r0/hub_v2025_r0.py b/box_sdk_gen/schemas/v2025_r0/hub_v2025_r0.py index 3c77dc73..0dee5226 100644 --- a/box_sdk_gen/schemas/v2025_r0/hub_v2025_r0.py +++ b/box_sdk_gen/schemas/v2025_r0/hub_v2025_r0.py @@ -1,3 +1,5 @@ +from enum import Enum + from typing import Optional from box_sdk_gen.schemas.v2025_r0.hub_base_v2025_r0 import HubBaseV2025R0TypeField @@ -11,6 +13,12 @@ from box_sdk_gen.internal.utils import DateTime +class HubV2025R0CopyHubAccessField(str, Enum): + ALL = 'all' + COMPANY = 'company' + NONE = 'none' + + class HubV2025R0(HubBaseV2025R0): _discriminator = 'type', {'hubs'} @@ -30,6 +38,7 @@ def __init__( can_non_owners_invite: Optional[bool] = None, can_shared_link_be_created: Optional[bool] = None, can_public_shared_link_be_created: Optional[bool] = None, + copy_hub_access: Optional[HubV2025R0CopyHubAccessField] = None, type: HubBaseV2025R0TypeField = HubBaseV2025R0TypeField.HUBS, **kwargs ): @@ -64,6 +73,12 @@ def __init__( :type can_shared_link_be_created: Optional[bool], optional :param can_public_shared_link_be_created: Indicates if a public shared link can be created for the Box Hub., defaults to None :type can_public_shared_link_be_created: Optional[bool], optional + :param copy_hub_access: Specifies who is allowed to copy the Box Hub. + + * `all` - Any user with access to the Hub can copy it. + * `company` - Only users within the same enterprise as the Hub can copy it. + * `none` - No one can copy the Hub., defaults to None + :type copy_hub_access: Optional[HubV2025R0CopyHubAccessField], optional :param type: The value will always be `hubs`., defaults to HubBaseV2025R0TypeField.HUBS :type type: HubBaseV2025R0TypeField, optional """ @@ -82,3 +97,4 @@ def __init__( self.can_non_owners_invite = can_non_owners_invite self.can_shared_link_be_created = can_shared_link_be_created self.can_public_shared_link_be_created = can_public_shared_link_be_created + self.copy_hub_access = copy_hub_access diff --git a/docs/ai.md b/docs/ai.md index 9861dd01..6c2ef21c 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -10,6 +10,10 @@ Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. +You can ask a question about a single file, several files, or the entire contents of a Box Hub. To search across and ask questions about everything in a Box Hub, send a single item with `type` set to `hubs` and the Hub's ID as the `id`. Box AI answers the question using the indexed content of all files in that Hub. + +Asking questions about a Box Hub requires Box AI for Hubs to be enabled in the Admin Console before the Hub is created, so that its content is indexed. + This operation is performed by calling function `create_ai_ask`. See the endpoint docs at @@ -39,12 +43,13 @@ client.ai.create_ai_ask( - prompt `str` - The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters. - items `List[AiItemAsk]` - - The items to be processed by the LLM, often files. + - The items to be processed by the LLM, often files. To search across and ask questions about the contents of a Box Hub, pass a single item with `type` set to `hubs`. See the item `type` property for details. - dialogue_history `Optional[List[AiDialogueHistory]]` - The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response. - include_citations `Optional[bool]` - A flag to indicate whether citations should be returned. - ai_agent `Optional[AiAskAgent]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -99,6 +104,7 @@ client.ai.create_ai_text_gen( - dialogue_history `Optional[List[AiDialogueHistory]]` - The history of prompts and answers previously passed to the LLM. This parameter provides the additional context to the LLM when generating the response. - ai_agent `Optional[AiTextGenAgent]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -175,6 +181,7 @@ client.ai.create_ai_extract( - items `List[AiItemBase]` - The items that LLM will process. Currently, you can use files only. - ai_agent `Optional[AiExtractAgent]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -294,6 +301,7 @@ client.ai.create_ai_extract_structured( - fields `Optional[List[CreateAiExtractStructuredFields]]` - The fields to be extracted from the provided items. For your request to work, you must provide either `metadata_template` or `fields`, but not both. - ai_agent `Optional[AiExtractStructuredAgent]` + - include_confidence_score `Optional[bool]` - A flag to indicate whether confidence scores for every extracted field should be returned. - include_reference `Optional[bool]` diff --git a/docs/ai_studio.md b/docs/ai_studio.md index 92e42046..908048b8 100644 --- a/docs/ai_studio.md +++ b/docs/ai_studio.md @@ -76,8 +76,11 @@ client.ai_studio.create_ai_agent( - allowed_entities `Optional[List[AiAgentAllowedEntity]]` - List of allowed users or groups. - ask `Optional[AiStudioAgentAsk]` + - text_gen `Optional[AiStudioAgentTextGen]` + - extract `Optional[AiStudioAgentExtract]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -122,8 +125,11 @@ client.ai_studio.update_ai_agent_by_id( - allowed_entities `Optional[List[AiAgentAllowedEntity]]` - List of allowed users or groups. - ask `Optional[AiStudioAgentAsk]` + - text_gen `Optional[AiStudioAgentTextGen]` + - extract `Optional[AiStudioAgentExtract]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/avatars.md b/docs/avatars.md index 702da504..85fd9e68 100644 --- a/docs/avatars.md +++ b/docs/avatars.md @@ -63,7 +63,9 @@ client.avatars.create_user_avatar( - pic `ByteStream` - The image file to be uploaded to Box. Accepted file extensions are `.jpg` or `.png`. The maximum file size is 1MB. - pic_file_name `Optional[str]` + - pic_content_type `Optional[str]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/chunked_uploads.md b/docs/chunked_uploads.md index d5d5d75a..64cbcb29 100644 --- a/docs/chunked_uploads.md +++ b/docs/chunked_uploads.md @@ -170,7 +170,7 @@ client.chunked_uploads.upload_file_part_by_url( - digest `str` - The [RFC3230][1] message digest of the chunk uploaded. Only SHA1 is supported. The SHA1 digest must be base64 encoded. The format of this header is as `sha=BASE64_ENCODED_DIGEST`. To get the value for the `SHA` digest, use the openSSL command to encode the file part: `openssl sha1 -binary | base64`. [1]: https://tools.ietf.org/html/rfc3230 - content_range `str` - - The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly equal in size to the part size specified in the upload session that you created. One exception is the last part of the file, as this can be smaller. When providing the value for `content-range`, remember that: _ The lower bound of each part's byte range must be a multiple of the part size. _ The higher bound must be a multiple of the part size - 1. + - The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly equal in size to the part size specified in the upload session that you created. One exception is the last part of the file, as this can be smaller. When providing the value for `content-range`, remember that: * The lower bound of each part's byte range must be a multiple of the part size. * The higher bound must be a multiple of the part size - 1. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -212,7 +212,7 @@ client.chunked_uploads.upload_file_part( - digest `str` - The [RFC3230][1] message digest of the chunk uploaded. Only SHA1 is supported. The SHA1 digest must be base64 encoded. The format of this header is as `sha=BASE64_ENCODED_DIGEST`. To get the value for the `SHA` digest, use the openSSL command to encode the file part: `openssl sha1 -binary | base64`. [1]: https://tools.ietf.org/html/rfc3230 - content_range `str` - - The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly equal in size to the part size specified in the upload session that you created. One exception is the last part of the file, as this can be smaller. When providing the value for `content-range`, remember that: _ The lower bound of each part's byte range must be a multiple of the part size. _ The higher bound must be a multiple of the part size - 1. + - The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly equal in size to the part size specified in the upload session that you created. One exception is the last part of the file, as this can be smaller. When providing the value for `content-range`, remember that: * The lower bound of each part's byte range must be a multiple of the part size. * The higher bound must be a multiple of the part size - 1. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/docgen.md b/docs/docgen.md index d0994c7e..44eb2f94 100644 --- a/docs/docgen.md +++ b/docs/docgen.md @@ -129,13 +129,17 @@ client.docgen.create_docgen_batch_v2025_r0( ### Arguments - file `FileReferenceV2025R0` + - file_version `Optional[FileVersionBaseV2025R0]` + - input_source `str` - Source of input. The value has to be `api` for all the API-based document generation requests. - destination_folder `CreateDocgenBatchV2025R0DestinationFolder` + - output_type `str` - Type of the output file. - document_generation_data `List[DocGenDocumentGenerationDataV2025R0]` + - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/docgen_template.md b/docs/docgen_template.md index e9e979a5..1b2238fb 100644 --- a/docs/docgen_template.md +++ b/docs/docgen_template.md @@ -25,6 +25,7 @@ client.docgen_template.create_docgen_template_v2025_r0(FileReferenceV2025R0(id=f ### Arguments - file `FileReferenceV2025R0` + - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/events.md b/docs/events.md index 80a656e4..c7e16dba 100644 --- a/docs/events.md +++ b/docs/events.md @@ -89,9 +89,9 @@ client.events.get_events() ### Arguments - stream_type `Optional[GetEventsStreamType]` - - Defines the type of events that are returned _ `all` returns everything for a user and is the default _ `changes` returns events that may cause file tree changes such as file updates or collaborations. _ `sync` is similar to `changes` but only applies to synced folders _ `admin_logs` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a `created_after` and `created_before` time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than `admin_logs_streaming`. \* `admin_logs_streaming` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than `admin_logs`, but events will not be returned in chronological order and may contain duplicates. + - Defines the type of events that are returned * `all` returns everything for a user and is the default * `changes` returns events that may cause file tree changes such as file updates or collaborations. * `sync` is similar to `changes` but only applies to synced folders * `admin_logs` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a `created_after` and `created_before` time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than `admin_logs_streaming`. * `admin_logs_streaming` returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than `admin_logs`, but events will not be returned in chronological order and may contain duplicates. - stream_position `Optional[str]` - - The location in the event stream to start receiving events from. _ `now` will return an empty list events and the latest stream position for initialization. _ `0` or `null` will return all events. + - The location in the event stream to start receiving events from. * `now` will return an empty list events and the latest stream position for initialization. * `0` or `null` will return all events. - limit `Optional[int]` - Limits the number of events returned. Note: Sometimes, the events less than the limit requested can be returned even when there may be more events remaining. This is primarily done in the case where a number of events have already been retrieved and these retrieved events are returned rather than delaying for an unknown amount of time to see if there are any more results. - event_type `Optional[List[GetEventsEventType]]` diff --git a/docs/files.md b/docs/files.md index 5698c052..201636b7 100644 --- a/docs/files.md +++ b/docs/files.md @@ -76,7 +76,9 @@ client.files.update_file_by_id( - description `Optional[str]` - The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description. - parent `Optional[UpdateFileByIdParent]` + - shared_link `Optional[UpdateFileByIdSharedLink]` + - lock `Optional[UpdateFileByIdLock]` - Defines a lock on an item. This prevents the item from being moved, renamed, or otherwise changed by anyone other than the user who created the lock. Set this to `null` to remove the lock. - disposition_at `Optional[DateTime]` diff --git a/docs/folders.md b/docs/folders.md index 62db04d5..8e255ee6 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -38,7 +38,7 @@ client.folders.get_folder_by_id("0") - 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. Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?fields=metadata.enterprise_12345.contractTemplate`. - sort `Optional[GetFolderByIdSort]` - - Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: _ **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. _ **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). \* **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. + - Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. * **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). * **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. - direction `Optional[GetFolderByIdDirection]` - The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order. - offset `Optional[int]` @@ -99,8 +99,11 @@ client.folders.update_folder_by_id( - can_non_owners_invite `Optional[bool]` - Specifies if users who are not the owner of the folder can invite new collaborators to the folder. - parent `Optional[UpdateFolderByIdParent]` + - shared_link `Optional[UpdateFolderByIdSharedLink]` + - folder_upload_email `Optional[UpdateFolderByIdFolderUploadEmail]` + - 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. - is_collaboration_restricted_to_enterprise `Optional[bool]` @@ -199,7 +202,7 @@ client.folders.get_folder_items(folder_origin.id) - limit `Optional[int]` - The maximum number of items to return per page. - sort `Optional[GetFolderItemsSort]` - - Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: _ **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. _ **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). \* **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. + - Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. * **Root folder**: This parameter is not supported for marker-based pagination on the root folder (the folder with an `id` of `0`). * **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links. - direction `Optional[GetFolderItemsDirection]` - The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order. - boxapi `Optional[str]` @@ -235,6 +238,7 @@ client.folders.create_folder(new_folder_name, CreateFolderParent(id="0")) - parent `CreateFolderParent` - The parent folder to create the new folder within. - folder_upload_email `Optional[CreateFolderFolderUploadEmail]` + - sync_state `Optional[CreateFolderSyncState]` - Specifies whether a folder should be synced to a user's device or not. This is used by Box Sync (discontinued) and is not used by Box Drive. - fields `Optional[List[str]]` diff --git a/docs/groups.md b/docs/groups.md index 6f1143c3..501f4164 100644 --- a/docs/groups.md +++ b/docs/groups.md @@ -71,7 +71,7 @@ client.groups.create_group(group_name, description=group_description) - invitability_level `Optional[CreateGroupInvitabilityLevel]` - Specifies who can invite the group to collaborate on folders. When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group. When set to `admins_and_members` all the admins listed above and group members can invite the group. When set to `all_managed_users` all managed users in the enterprise can invite the group. - member_viewability_level `Optional[CreateGroupMemberViewabilityLevel]` - - Specifies who can see the members of the group. _ `admins_only` - the enterprise admin, co-admins, group's group admin. _ `admins_and_members` - all admins and group members. \* `all_managed_users` - all managed users in the enterprise. + - Specifies who can see the members of the group. * `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise. - 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. - extra_headers `Optional[Dict[str, Optional[str]]]` @@ -149,7 +149,7 @@ client.groups.update_group_by_id(group.id, name=updated_group_name) - invitability_level `Optional[UpdateGroupByIdInvitabilityLevel]` - Specifies who can invite the group to collaborate on folders. When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group. When set to `admins_and_members` all the admins listed above and group members can invite the group. When set to `all_managed_users` all managed users in the enterprise can invite the group. - member_viewability_level `Optional[UpdateGroupByIdMemberViewabilityLevel]` - - Specifies who can see the members of the group. _ `admins_only` - the enterprise admin, co-admins, group's group admin. _ `admins_and_members` - all admins and group members. \* `all_managed_users` - all managed users in the enterprise. + - Specifies who can see the members of the group. * `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise. - 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. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/hubs.md b/docs/hubs.md index 54e0de22..7ef44e9f 100644 --- a/docs/hubs.md +++ b/docs/hubs.md @@ -190,6 +190,8 @@ client.hubs.update_hub_by_id_v2025_r0( - Indicates if a shared link can be created for the Box Hub. - can_public_shared_link_be_created `Optional[bool]` - Indicates if a public shared link can be created for the Box Hub. +- copy_hub_access `Optional[UpdateHubByIdV2025R0CopyHubAccess]` + - Specifies who is allowed to copy the Box Hub. * `all` - Any user with access to the Hub can copy it. * `company` - Only users within the same enterprise as the Hub can copy it. * `none` - No one can copy the Hub. - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` @@ -259,6 +261,8 @@ client.hubs.copy_hub_v2025_r0( - Title of the Box Hub. It cannot be empty and should be less than 50 characters. - description `Optional[str]` - Description of the Box Hub. +- include_items `Optional[bool]` + - If true, the items which the user has Editor or Owner access to in the original Box Hub will be copied to the new Box Hub. Defaults to false. - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/integration_mappings.md b/docs/integration_mappings.md index 1b48ead7..6da6a251 100644 --- a/docs/integration_mappings.md +++ b/docs/integration_mappings.md @@ -79,8 +79,11 @@ user_client.integration_mappings.create_slack_integration_mapping( ### Arguments - partner_item `IntegrationMappingPartnerItemSlack` + - box_item `IntegrationMappingBoxItemSlack` + - options `Optional[IntegrationMappingSlackOptions]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -116,7 +119,9 @@ user_client.integration_mappings.update_slack_integration_mapping_by_id( - integration_mapping_id `str` - An ID of an integration mapping. Example: "11235432" - box_item `Optional[IntegrationMappingBoxItemSlack]` + - options `Optional[IntegrationMappingSlackOptions]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -224,7 +229,9 @@ user_client.integration_mappings.create_teams_integration_mapping( ### Arguments - partner_item `IntegrationMappingPartnerItemTeamsCreateRequest` + - box_item `FolderReference` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -259,6 +266,7 @@ user_client.integration_mappings.update_teams_integration_mapping_by_id( - integration_mapping_id `str` - An ID of an integration mapping. Example: "11235432" - box_item `Optional[FolderReference]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/metadata_cascade_policies.md b/docs/metadata_cascade_policies.md index b1d7b0bb..c161a2e0 100644 --- a/docs/metadata_cascade_policies.md +++ b/docs/metadata_cascade_policies.md @@ -163,7 +163,7 @@ client.metadata_cascade_policies.apply_metadata_cascade_policy( - metadata_cascade_policy_id `str` - The ID of the cascade policy to force-apply. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" - conflict_resolution `ApplyMetadataCascadePolicyConflictResolution` - - Describes the desired behavior when dealing with the conflict where a metadata template already has an instance applied to a child. _ `none` will preserve the existing value on the file _ `overwrite` will force-apply the templates values over any existing values. + - Describes the desired behavior when dealing with the conflict where a metadata template already has an instance applied to a child. * `none` will preserve the existing value on the file * `overwrite` will force-apply the templates values over any existing values. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/notes.md b/docs/notes.md index c4f482b3..28b9aab9 100644 --- a/docs/notes.md +++ b/docs/notes.md @@ -29,6 +29,7 @@ client.notes.create_note_convert_v2026_r0( - content_format `CreateNoteConvertV2026R0ContentFormat` - Format of the content to convert. - parent `FolderReferenceV2026R0` + - name `str` - The name for the created note. The `.boxnote` extension is appended automatically. - box_version `BoxVersionHeaderV2026R0` diff --git a/docs/retention_policies.md b/docs/retention_policies.md index 1211508d..f342ff72 100644 --- a/docs/retention_policies.md +++ b/docs/retention_policies.md @@ -81,10 +81,11 @@ client.retention_policies.create_retention_policy( - retention_length `Optional[Union[str, int]]` - The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a `policy_type` of `indefinite`, the `retention_length` will also be `indefinite`. - retention_type `Optional[CreateRetentionPolicyRetentionType]` - - Specifies the retention type: _ `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. _ `non_modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. + - Specifies the retention type: * `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. * `non_modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. - can_owner_extend_retention `Optional[bool]` - Whether the owner of a file will be allowed to extend the retention. - max_extension_length `Optional[RetentionPolicyMaxExtensionLengthRequest]` + - are_owners_notified `Optional[bool]` - Whether owner and co-owners of a file are notified when the policy nears expiration. - custom_notification_recipients `Optional[List[UserMini]]` @@ -156,7 +157,7 @@ client.retention_policies.update_retention_policy_by_id( - disposition_action `Optional[str]` - The disposition action of the retention policy. This action can be `permanently_delete`, which will cause the content retained by the policy to be permanently deleted, or `remove_retention`, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired. You can use `null` if you don't want to change `disposition_action`. - retention_type `Optional[str]` - - Specifies the retention type: _ `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. _ `non-modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. When updating a retention policy, you can use `non-modifiable` type only. You can convert a `modifiable` policy to `non-modifiable`, but not the other way around. + - Specifies the retention type: * `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. * `non-modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. When updating a retention policy, you can use `non-modifiable` type only. You can convert a `modifiable` policy to `non-modifiable`, but not the other way around. - retention_length `Optional[Union[str, int]]` - The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a `policy_type` of `indefinite`, the `retention_length` will also be `indefinite`. - status `Optional[str]` @@ -164,6 +165,7 @@ client.retention_policies.update_retention_policy_by_id( - can_owner_extend_retention `Optional[bool]` - Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end. - max_extension_length `Optional[RetentionPolicyMaxExtensionLengthRequest]` + - are_owners_notified `Optional[bool]` - Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end. - custom_notification_recipients `Optional[List[UserBase]]` diff --git a/docs/search.md b/docs/search.md index c2c2e27d..9e0012a4 100644 --- a/docs/search.md +++ b/docs/search.md @@ -36,7 +36,7 @@ client.search.search_by_metadata_query( ### Arguments -- from\_ `str` +- from_ `str` - Specifies the template used in the query. Must be in the form `scope.templateKey`. Not all templates can be used in this field, most notably the built-in, Box-provided classification templates can not be used in a query. - query `Optional[str]` - The query to perform. A query is a logical expression that is very similar to a SQL `SELECT` statement. Values in the search query can be turned into parameters specified in the `query_param` arguments list to prevent having to manually insert search values into the query string. For example, a value of `:amount` would represent the `amount` value in `query_params` object. @@ -51,7 +51,7 @@ client.search.search_by_metadata_query( - marker `Optional[str]` - Marker to use for requesting the next page. - fields `Optional[List[str]]` - - By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers. For example: _ `created_by` will add the details of the user who created the item to the response. _ `metadata..` will return the mini-representation of the metadata instance identified by the `scope` and `templateKey`. \* `metadata...` will return all the mini-representation of the metadata instance identified by the `scope` and `templateKey` plus the field specified by the `field` name. Multiple fields for the same `scope` and `templateKey` can be defined. + - By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers. For example: * `created_by` will add the details of the user who created the item to the response. * `metadata..` will return the mini-representation of the metadata instance identified by the `scope` and `templateKey`. * `metadata...` will return all the mini-representation of the metadata instance identified by the `scope` and `templateKey` plus the field specified by the `field` name. Multiple fields for the same `scope` and `templateKey` can be defined. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -89,7 +89,7 @@ client.search.search_for_content( ### Arguments - query `Optional[str]` - - The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. This parameter supports a variety of operators to further refine the results returns. _ `""` - by wrapping a query in double quotes only exact matches are returned by the API. Exact searches do not return search matches based on specific character sequences. Instead, they return matches based on phrases, that is, word sequences. For example: A search for `"Blue-Box"` may return search results including the sequence `"blue.box"`, `"Blue Box"`, and `"Blue-Box"`; any item containing the words `Blue` and `Box` consecutively, in the order specified. _ `AND` - returns items that contain both the search terms. For example, a search for `marketing AND BoxWorks` returns items that have both `marketing` and `BoxWorks` within its text in any order. It does not return a result that only has `BoxWorks` in its text. _ `OR` - returns items that contain either of the search terms. For example, a search for `marketing OR BoxWorks` returns a result that has either `marketing` or `BoxWorks` within its text. Using this operator is not necessary as we implicitly interpret multi-word queries as `OR` unless another supported boolean term is used. _ `NOT` - returns items that do not contain the search term provided. For example, a search for `marketing AND NOT BoxWorks` returns a result that has only `marketing` within its text. Results containing `BoxWorks` are omitted. We do not support lower case (that is, `and`, `or`, and `not`) or mixed case (that is, `And`, `Or`, and `Not`) operators. This field is required unless the `mdfilters` parameter is defined. + - The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. This parameter supports a variety of operators to further refine the results returns. * `""` - by wrapping a query in double quotes only exact matches are returned by the API. Exact searches do not return search matches based on specific character sequences. Instead, they return matches based on phrases, that is, word sequences. For example: A search for `"Blue-Box"` may return search results including the sequence `"blue.box"`, `"Blue Box"`, and `"Blue-Box"`; any item containing the words `Blue` and `Box` consecutively, in the order specified. * `AND` - returns items that contain both the search terms. For example, a search for `marketing AND BoxWorks` returns items that have both `marketing` and `BoxWorks` within its text in any order. It does not return a result that only has `BoxWorks` in its text. * `OR` - returns items that contain either of the search terms. For example, a search for `marketing OR BoxWorks` returns a result that has either `marketing` or `BoxWorks` within its text. Using this operator is not necessary as we implicitly interpret multi-word queries as `OR` unless another supported boolean term is used. * `NOT` - returns items that do not contain the search term provided. For example, a search for `marketing AND NOT BoxWorks` returns a result that has only `marketing` within its text. Results containing `BoxWorks` are omitted. We do not support lower case (that is, `and`, `or`, and `not`) or mixed case (that is, `And`, `Or`, and `Not`) operators. This field is required unless the `mdfilters` parameter is defined. - scope `Optional[SearchForContentScope]` - Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to `user_content`, which limits the search results to content that is available to the currently authenticated user. The `enterprise_content` can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to. - file_extensions `Optional[List[str]]` @@ -107,15 +107,15 @@ client.search.search_for_content( - ancestor_folder_ids `Optional[List[str]]` - Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will also include items within any subfolders of those ancestor folders. The folders still need to be owned or shared with the currently authenticated user. If the folder is not accessible by this user, or it does not exist, a `HTTP 404` error code will be returned instead. To search across an entire enterprise, we recommend using the `enterprise_content` scope parameter which can be requested with our support team. - content_types `Optional[List[SearchForContentContentTypes]]` - - Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. _ `name` - The name of the item, as defined by its `name` field. _ `description` - The description of the item, as defined by its `description` field. _ `file_content` - The actual content of the file. _ `comments` - The content of any of the comments on a file or folder. \* `tags` - Any tags that are applied to an item, as defined by its `tags` field. + - Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. * `name` - The name of the item, as defined by its `name` field. * `description` - The description of the item, as defined by its `description` field. * `file_content` - The actual content of the file. * `comments` - The content of any of the comments on a file or folder. * `tags` - Any tags that are applied to an item, as defined by its `tags` field. - type `Optional[SearchForContentType]` - - Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. _ `file` - Limits the search results to files, _ `folder` - Limits the search results to folders, \* `web_link` - Limits the search results to web links, also known as bookmarks. + - Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. * `file` - Limits the search results to files, * `folder` - Limits the search results to folders, * `web_link` - Limits the search results to web links, also known as bookmarks. - trash_content `Optional[SearchForContentTrashContent]` - - Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (`non_trashed_only`). _ `trashed_only` - Only searches for items currently in the trash _ `non_trashed_only` - Only searches for items currently not in the trash \* `all_items` - Searches for both trashed and non-trashed items. + - Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (`non_trashed_only`). * `trashed_only` - Only searches for items currently in the trash * `non_trashed_only` - Only searches for items currently not in the trash * `all_items` - Searches for both trashed and non-trashed items. - mdfilters `Optional[List[MetadataFilter]]` - Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly **one** metadata template used to filter the search results. The parameter is required unless the `query` parameter is provided. - sort `Optional[SearchForContentSort]` - - Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. _ `relevance` (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. _ `modified_at` returns the results ordered in descending order by date at which the item was last modified. + - Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. * `relevance` (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. * `modified_at` returns the results ordered in descending order by date at which the item was last modified. - direction `Optional[SearchForContentDirection]` - Defines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this parameter is explicitly specified. When results are sorted by `relevance` the ordering is locked to returning items in descending order of relevance, and this parameter is ignored. - limit `Optional[int]` diff --git a/docs/shield_information_barrier_reports.md b/docs/shield_information_barrier_reports.md index f9b7990e..1bc17210 100644 --- a/docs/shield_information_barrier_reports.md +++ b/docs/shield_information_barrier_reports.md @@ -61,6 +61,7 @@ client.shield_information_barrier_reports.create_shield_information_barrier_repo ### Arguments - shield_information_barrier `Optional[ShieldInformationBarrierBase]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/shield_information_barrier_segment_members.md b/docs/shield_information_barrier_segment_members.md index 13fa7510..a81521be 100644 --- a/docs/shield_information_barrier_segment_members.md +++ b/docs/shield_information_barrier_segment_members.md @@ -130,6 +130,7 @@ client.shield_information_barrier_segment_members.create_shield_information_barr - type `Optional[CreateShieldInformationBarrierSegmentMemberType]` - A type of the shield barrier segment member. - shield_information_barrier `Optional[ShieldInformationBarrierBase]` + - shield_information_barrier_segment `CreateShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment` - The `type` and `id` of the requested shield information barrier segment. - user `UserBase` diff --git a/docs/shield_information_barrier_segment_restrictions.md b/docs/shield_information_barrier_segment_restrictions.md index d18dbbe5..47fdbe5a 100644 --- a/docs/shield_information_barrier_segment_restrictions.md +++ b/docs/shield_information_barrier_segment_restrictions.md @@ -135,6 +135,7 @@ client.shield_information_barrier_segment_restrictions.create_shield_information - type `CreateShieldInformationBarrierSegmentRestrictionType` - The type of the shield barrier segment restriction for this member. - shield_information_barrier `Optional[ShieldInformationBarrierBase]` + - shield_information_barrier_segment `CreateShieldInformationBarrierSegmentRestrictionShieldInformationBarrierSegment` - The `type` and `id` of the requested shield information barrier segment. - restricted_segment `CreateShieldInformationBarrierSegmentRestrictionRestrictedSegment` diff --git a/docs/shield_information_barrier_segments.md b/docs/shield_information_barrier_segments.md index c208101e..20a59505 100644 --- a/docs/shield_information_barrier_segments.md +++ b/docs/shield_information_barrier_segments.md @@ -161,6 +161,7 @@ client.shield_information_barrier_segments.create_shield_information_barrier_seg ### Arguments - shield_information_barrier `ShieldInformationBarrierBase` + - name `str` - Name of the shield information barrier segment. - description `Optional[str]` diff --git a/docs/shield_lists.md b/docs/shield_lists.md index 39505cad..a92bf942 100644 --- a/docs/shield_lists.md +++ b/docs/shield_lists.md @@ -63,6 +63,7 @@ client.shield_lists.create_shield_list_v2025_r0( - description `Optional[str]` - Optional description of Shield List. - content `ShieldListContentRequestV2025R0` + - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` @@ -165,6 +166,7 @@ client.shield_lists.update_shield_list_by_id_v2025_r0( - description `Optional[str]` - Optional description of Shield List. - content `ShieldListContentRequestV2025R0` + - box_version `BoxVersionHeaderV2025R0` - Version header. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/sign_requests.md b/docs/sign_requests.md index 1abe8c88..cd248116 100644 --- a/docs/sign_requests.md +++ b/docs/sign_requests.md @@ -180,6 +180,7 @@ client.sign_requests.create_sign_request( - 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](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. - redirect_url `Optional[str]` @@ -206,6 +207,8 @@ client.sign_requests.create_sign_request( - When a signature request is created from a template this field will indicate the id of that template. - external_system_name `Optional[str]` - Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`. +- request_flow `Optional[str]` + - The flow type of the sign request. Values can include `standard` or `cfr11`. When not specified during creation, a default is chosen based on admin settings. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/task_assignments.md b/docs/task_assignments.md index c0fcbefb..13def3f2 100644 --- a/docs/task_assignments.md +++ b/docs/task_assignments.md @@ -127,7 +127,7 @@ client.task_assignments.update_task_assignment_by_id( - message `Optional[str]` - An optional message by the assignee that can be added to the task. - resolution_state `Optional[UpdateTaskAssignmentByIdResolutionState]` - - The state of the task assigned to the user. _ For a task with an `action` value of `complete` this can be `incomplete` or `completed`. _ For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`. + - The state of the task assigned to the user. * For a task with an `action` value of `complete` this can be `incomplete` or `completed`. * For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/tasks.md b/docs/tasks.md index ae6dc3b5..86681e7b 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -65,13 +65,13 @@ client.tasks.create_task( - item `CreateTaskItem` - The file to attach the task to. - action `Optional[CreateTaskAction]` - - The action the task assignee will be prompted to do. Must be _ `review` defines an approval task that can be approved or, rejected _ `complete` defines a general task which can be completed. + - The action the task assignee will be prompted to do. Must be * `review` defines an approval task that can be approved or, rejected * `complete` defines a general task which can be completed. - message `Optional[str]` - An optional message to include with the task. - due_at `Optional[DateTime]` - Defines when the task is due. Defaults to `null` if not provided. - completion_rule `Optional[CreateTaskCompletionRule]` - - Defines which assignees need to complete this task before the task is considered completed. _ `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. _ `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed. + - Defines which assignees need to complete this task before the task is considered completed. * `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -130,13 +130,13 @@ client.tasks.update_task_by_id(task.id, message="updated message") - task_id `str` - The ID of the task. Example: "12345" - action `Optional[UpdateTaskByIdAction]` - - The action the task assignee will be prompted to do. Must be _ `review` defines an approval task that can be approved or rejected, _ `complete` defines a general task which can be completed. + - The action the task assignee will be prompted to do. Must be * `review` defines an approval task that can be approved or rejected, * `complete` defines a general task which can be completed. - message `Optional[str]` - The message included with the task. - due_at `Optional[DateTime]` - When the task is due at. - completion_rule `Optional[UpdateTaskByIdCompletionRule]` - - Defines which assignees need to complete this task before the task is considered completed. _ `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. _ `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed. + - Defines which assignees need to complete this task before the task is considered completed. * `all_assignees` (default) requires all assignees to review or approve the task in order for it to be considered completed. * `any_assignee` accepts any one assignee to review or approve the task in order for it to be considered completed. - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/trashed_files.md b/docs/trashed_files.md index 0afadfa8..32f08cc1 100644 --- a/docs/trashed_files.md +++ b/docs/trashed_files.md @@ -29,6 +29,7 @@ client.trashed_files.restore_file_from_trash(file.id) - name `Optional[str]` - An optional new name for the file. - parent `Optional[RestoreFileFromTrashParent]` + - 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. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/trashed_folders.md b/docs/trashed_folders.md index 8be20350..67c8b7da 100644 --- a/docs/trashed_folders.md +++ b/docs/trashed_folders.md @@ -36,6 +36,7 @@ client.trashed_folders.restore_folder_from_trash(folder.id) - name `Optional[str]` - An optional new name for the folder. - parent `Optional[RestoreFolderFromTrashParent]` + - 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. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/trashed_web_links.md b/docs/trashed_web_links.md index b1d31d08..97d52542 100644 --- a/docs/trashed_web_links.md +++ b/docs/trashed_web_links.md @@ -29,6 +29,7 @@ client.trashed_web_links.restore_weblink_from_trash(weblink.id) - name `Optional[str]` - An optional new name for the web link. - parent `Optional[RestoreWeblinkFromTrashParent]` + - 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. - extra_headers `Optional[Dict[str, Optional[str]]]` diff --git a/docs/uploads.md b/docs/uploads.md index 8d409530..a5ff6ce5 100644 --- a/docs/uploads.md +++ b/docs/uploads.md @@ -39,7 +39,9 @@ client.uploads.upload_file_version( - file `ByteStream` - The content of the file to upload to Box. The `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading the file will receive a HTTP `400` error with a `metadata_after_file_contents` error code. - file_file_name `Optional[str]` + - file_content_type `Optional[str]` + - 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. - if_match `Optional[str]` @@ -80,6 +82,7 @@ client.uploads.preflight_file_upload_check( - size `Optional[int]` - The size of the file in bytes. - parent `Optional[PreflightFileUploadCheckParent]` + - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -123,7 +126,9 @@ client.uploads.upload_file( - file `ByteStream` - The content of the file to upload to Box. The `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading the file will receive a HTTP `400` error with a `metadata_after_file_contents` error code. - file_file_name `Optional[str]` + - file_content_type `Optional[str]` + - 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. - content_md_5 `Optional[str]` @@ -157,10 +162,13 @@ client.uploads.upload_with_preflight_check( ### Arguments - attributes `UploadWithPreflightCheckAttributes` + - file `ByteStream` - The content of the file to upload to Box. The `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading the file will receive a HTTP `400` error with a `metadata_after_file_contents` error code. - file_file_name `Optional[str]` + - file_content_type `Optional[str]` + - 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. - content_md_5 `Optional[str]` diff --git a/docs/users.md b/docs/users.md index 980e5d87..178dd4dc 100644 --- a/docs/users.md +++ b/docs/users.md @@ -32,7 +32,7 @@ client.users.get_users() - filter_term `Optional[str]` - Limits the results to only users who's `name` or `login` start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time. - user_type `Optional[GetUsersUserType]` - - Limits the results to the kind of user specified. _ `all` returns every kind of user for whom the `login` or `name` partially matches the `filter_term`. It will only return an external user if the login matches the `filter_term` completely, and in that case it will only return that user. _ `managed` returns all managed and app users for whom the `login` or `name` partially matches the `filter_term`. \* `external` returns all external users for whom the `login` matches the `filter_term` exactly. + - Limits the results to the kind of user specified. * `all` returns every kind of user for whom the `login` or `name` partially matches the `filter_term`. It will only return an external user if the login matches the `filter_term` completely, and in that case it will only return that user. * `managed` returns all managed and app users for whom the `login` or `name` partially matches the `filter_term`. * `external` returns all external users for whom the `login` matches the `filter_term` exactly. - external_app_user_id `Optional[str]` - Limits the results to app users with the given `external_app_user_id` value. When creating an app user, an `external_app_user_id` value can be set. This value can then be used in this endpoint to find any users that match that `external_app_user_id` value. - fields `Optional[List[str]]` diff --git a/docs/web_links.md b/docs/web_links.md index 1700761f..66ff7f69 100644 --- a/docs/web_links.md +++ b/docs/web_links.md @@ -102,6 +102,7 @@ client.web_links.update_web_link_by_id( - url `Optional[str]` - The new URL that the web link links to. Must start with `"http://"` or `"https://"`. - parent `Optional[UpdateWebLinkByIdParent]` + - name `Optional[str]` - A new name for the web link. Defaults to the URL if not set. - description `Optional[str]` From abfaf307d4615986c52801206f7315c5e0493201 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 29 Jun 2026 08:50:05 -0700 Subject: [PATCH 4/4] chore: Update `.codegen.json` with commit hash of `codegen` and `openapi` spec [skip ci] --- .codegen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codegen.json b/.codegen.json index 1947d1b9..e0d71777 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "6f9492d", "specHash": "131c54a", "version": "10.12.0" } +{ "engineHash": "9c2d390", "specHash": "131c54a", "version": "10.12.0" }