From 08879ae214dc8260269c766e913fb4955c8376c5 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Wed, 23 Jul 2025 00:11:25 -0700 Subject: [PATCH] fix: Fix docs generation (box/box-codegen#767) --- .codegen.json | 2 +- docs/ai.md | 4 ---- docs/ai_studio.md | 6 ------ docs/avatars.md | 2 -- docs/docgen.md | 4 ---- docs/docgen_template.md | 1 - docs/files.md | 2 -- docs/folders.md | 4 ---- docs/integration_mappings.md | 8 -------- docs/shield_information_barrier_reports.md | 1 - docs/shield_information_barrier_segment_members.md | 1 - docs/shield_information_barrier_segment_restrictions.md | 1 - docs/shield_information_barrier_segments.md | 1 - docs/shield_lists.md | 2 -- docs/sign_requests.md | 1 - docs/trashed_files.md | 1 - docs/trashed_folders.md | 1 - docs/trashed_web_links.md | 1 - docs/uploads.md | 8 -------- docs/web_links.md | 1 - 20 files changed, 1 insertion(+), 51 deletions(-) diff --git a/.codegen.json b/.codegen.json index 20c21a8f..5a00463c 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "66d6f32", "specHash": "eaa9cf0", "version": "1.15.0" } +{ "engineHash": "43a5daf", "specHash": "eaa9cf0", "version": "1.15.0" } diff --git a/docs/ai.md b/docs/ai.md index 6a8d1c71..59784e91 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -45,7 +45,6 @@ client.ai.create_ai_ask( - include_citations `Optional[bool]` - A flag to indicate whether citations should be returned. - ai_agent `Optional[Union[AiAgentAsk, AiAgentReference]]` - - - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -101,7 +100,6 @@ 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[Union[AiAgentReference, AiAgentTextGen]]` - - - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -178,7 +176,6 @@ client.ai.create_ai_extract( - items `List[AiItemBase]` - The items that LLM will process. Currently, you can use files only. - ai_agent `Optional[Union[AiAgentReference, AiAgentExtract]]` - - - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. @@ -260,7 +257,6 @@ 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[Union[AiAgentReference, AiAgentExtractStructured]]` - - - extra_headers `Optional[Dict[str, Optional[str]]]` - Extra headers that will be included in the HTTP request. diff --git a/docs/ai_studio.md b/docs/ai_studio.md index 0b2da21b..92e42046 100644 --- a/docs/ai_studio.md +++ b/docs/ai_studio.md @@ -76,11 +76,8 @@ 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. @@ -125,11 +122,8 @@ 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 3da6012f..702da504 100644 --- a/docs/avatars.md +++ b/docs/avatars.md @@ -63,9 +63,7 @@ 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/docgen.md b/docs/docgen.md index 47d09eea..6e2a00ba 100644 --- a/docs/docgen.md +++ b/docs/docgen.md @@ -129,17 +129,13 @@ 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 b939b99a..e9e979a5 100644 --- a/docs/docgen_template.md +++ b/docs/docgen_template.md @@ -25,7 +25,6 @@ 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/files.md b/docs/files.md index 23155520..9ce0de62 100644 --- a/docs/files.md +++ b/docs/files.md @@ -76,9 +76,7 @@ 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 957fd724..fa2d3332 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -99,11 +99,8 @@ 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]` @@ -238,7 +235,6 @@ 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/integration_mappings.md b/docs/integration_mappings.md index c94b3daa..1b48ead7 100644 --- a/docs/integration_mappings.md +++ b/docs/integration_mappings.md @@ -79,11 +79,8 @@ 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. @@ -119,9 +116,7 @@ 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. @@ -229,9 +224,7 @@ 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. @@ -266,7 +259,6 @@ 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/shield_information_barrier_reports.md b/docs/shield_information_barrier_reports.md index 12e278f1..f9b7990e 100644 --- a/docs/shield_information_barrier_reports.md +++ b/docs/shield_information_barrier_reports.md @@ -61,7 +61,6 @@ 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 d1a6d001..13fa7510 100644 --- a/docs/shield_information_barrier_segment_members.md +++ b/docs/shield_information_barrier_segment_members.md @@ -130,7 +130,6 @@ 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 47c82d54..d18dbbe5 100644 --- a/docs/shield_information_barrier_segment_restrictions.md +++ b/docs/shield_information_barrier_segment_restrictions.md @@ -135,7 +135,6 @@ 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 a13f7ea4..c208101e 100644 --- a/docs/shield_information_barrier_segments.md +++ b/docs/shield_information_barrier_segments.md @@ -161,7 +161,6 @@ 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 24acb5b0..39505cad 100644 --- a/docs/shield_lists.md +++ b/docs/shield_lists.md @@ -63,7 +63,6 @@ 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]]]` @@ -166,7 +165,6 @@ 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 8f5bd25f..bee34665 100644 --- a/docs/sign_requests.md +++ b/docs/sign_requests.md @@ -178,7 +178,6 @@ 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](r://shield-information-barrier-segment-member) (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send the sign request will result in an error. Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ). - 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]` diff --git a/docs/trashed_files.md b/docs/trashed_files.md index 05c845aa..3b77196f 100644 --- a/docs/trashed_files.md +++ b/docs/trashed_files.md @@ -29,7 +29,6 @@ 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 3cd507b1..66a0f27f 100644 --- a/docs/trashed_folders.md +++ b/docs/trashed_folders.md @@ -36,7 +36,6 @@ 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 5b7d161e..b1d31d08 100644 --- a/docs/trashed_web_links.md +++ b/docs/trashed_web_links.md @@ -29,7 +29,6 @@ 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 bd35be52..8d409530 100644 --- a/docs/uploads.md +++ b/docs/uploads.md @@ -39,9 +39,7 @@ 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]` @@ -82,7 +80,6 @@ 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. @@ -126,9 +123,7 @@ 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]` @@ -162,13 +157,10 @@ 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/web_links.md b/docs/web_links.md index 528ca9fa..1700761f 100644 --- a/docs/web_links.md +++ b/docs/web_links.md @@ -102,7 +102,6 @@ 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]`