From f627216c23c791cf667fe1f515e8f0c57dfa2fbc Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Thu, 9 May 2024 06:49:07 -0700 Subject: [PATCH] feat: add documentation to folder resource (box/box-openapi#421) --- .codegen.json | 2 +- box_sdk_gen/managers/search.py | 2 +- box_sdk_gen/schemas.py | 16 ++++++++++++++++ docs/search.md | 2 +- 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/.codegen.json b/.codegen.json index ff0f5f1..1ad101c 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "c70ff82", "specHash": "f7e92ba", "version": "0.6.4" } +{ "engineHash": "c70ff82", "specHash": "d5769a1", "version": "0.6.4" } diff --git a/box_sdk_gen/managers/search.py b/box_sdk_gen/managers/search.py index ac7d94d..74d32ad 100644 --- a/box_sdk_gen/managers/search.py +++ b/box_sdk_gen/managers/search.py @@ -430,7 +430,7 @@ def search_for_content( :type trash_content: Optional[SearchForContentTrashContent], optional :param mdfilters: 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. - It is required unless the `query` parameter is provided., defaults to None + It unless the `query` parameter is provided., defaults to None :type mdfilters: Optional[List[MetadataFilter]], optional :param sort: Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is diff --git a/box_sdk_gen/schemas.py b/box_sdk_gen/schemas.py index e5b1780..318e92e 100644 --- a/box_sdk_gen/schemas.py +++ b/box_sdk_gen/schemas.py @@ -8467,6 +8467,14 @@ def __init__( :type content_created_at: Optional[DateTime], optional :param content_modified_at: The date and time at which this folder was last updated., defaults to None :type content_modified_at: Optional[DateTime], optional + :param folder_upload_email: The `folder_upload_email` parameter is not `null` if one of the following options is **true**: + + * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted. + + * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked). + + If the conditions are not met, the parameter will have the following value: `folder_upload_email: null`, defaults to None + :type folder_upload_email: Optional[FolderFolderUploadEmailField], optional :param item_status: Defines if this item has been deleted or not. * `active` when the item has is not in the trash @@ -8876,6 +8884,14 @@ def __init__( :type content_created_at: Optional[DateTime], optional :param content_modified_at: The date and time at which this folder was last updated., defaults to None :type content_modified_at: Optional[DateTime], optional + :param folder_upload_email: The `folder_upload_email` parameter is not `null` if one of the following options is **true**: + + * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted. + + * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked). + + If the conditions are not met, the parameter will have the following value: `folder_upload_email: null`, defaults to None + :type folder_upload_email: Optional[FolderFolderUploadEmailField], optional :param item_status: Defines if this item has been deleted or not. * `active` when the item has is not in the trash diff --git a/docs/search.md b/docs/search.md index 9566c64..3bb2c2d 100644 --- a/docs/search.md +++ b/docs/search.md @@ -93,7 +93,7 @@ client.search.search_for_content(ancestor_folder_ids=['0'], mdfilters=[MetadataF - 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. - 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. It is required unless the `query` parameter is provided. + - 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. It 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. - direction `Optional[SearchForContentDirection]`