Skip to content

Commit

Permalink
feat: add documentation to folder resource (box/box-openapi#421)
Browse files Browse the repository at this point in the history
  • Loading branch information
box-sdk-build committed May 9, 2024
1 parent 03ef3f1 commit f627216
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "c70ff82", "specHash": "f7e92ba", "version": "0.6.4" }
{ "engineHash": "c70ff82", "specHash": "d5769a1", "version": "0.6.4" }
2 changes: 1 addition & 1 deletion box_sdk_gen/managers/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 16 additions & 0 deletions box_sdk_gen/schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]`
Expand Down

0 comments on commit f627216

Please sign in to comment.