diff --git a/.codegen.json b/.codegen.json index 55c990b7..df121840 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "e12401a", "specHash": "d50ab5f", "version": "0.6.3" } +{ "engineHash": "e12401a", "specHash": "1698c95", "version": "0.6.3" } diff --git a/box_sdk_gen/managers/files.py b/box_sdk_gen/managers/files.py index bf594417..ada58301 100644 --- a/box_sdk_gen/managers/files.py +++ b/box_sdk_gen/managers/files.py @@ -250,7 +250,7 @@ def get_file_by_id( 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 - `?field=metadata.enterprise_12345.contractTemplate`., defaults to None + `?fields=metadata.enterprise_12345.contractTemplate`., defaults to None :type fields: Optional[List[str]], optional :param if_none_match: Ensures an item is only returned if it has changed. diff --git a/box_sdk_gen/managers/folders.py b/box_sdk_gen/managers/folders.py index c0988c8e..ec8a9ac6 100644 --- a/box_sdk_gen/managers/folders.py +++ b/box_sdk_gen/managers/folders.py @@ -330,7 +330,7 @@ def get_folder_by_id( 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 - `?field=metadata.enterprise_12345.contractTemplate`., defaults to None + `?fields=metadata.enterprise_12345.contractTemplate`., defaults to None :type fields: Optional[List[str]], optional :param sort: Defines the **second** attribute by which items are sorted. @@ -693,7 +693,7 @@ def get_folder_items( 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 - `?field=metadata.enterprise_12345.contractTemplate`., defaults to None + `?fields=metadata.enterprise_12345.contractTemplate`., defaults to None :type fields: Optional[List[str]], optional :param usemarker: Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can diff --git a/docs/files.md b/docs/files.md index 186c8f84..b25c5f10 100644 --- a/docs/files.md +++ b/docs/files.md @@ -26,7 +26,7 @@ client.files.get_file_by_id(file.id) - file_id `str` - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" - 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 `?field=metadata.enterprise_12345.contractTemplate`. + - 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`. - if_none_match `Optional[str]` - Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will fail with a `304 Not Modified` if the item has not changed since. - boxapi `Optional[str]` diff --git a/docs/folders.md b/docs/folders.md index 3791b1b7..7e63a91a 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -36,7 +36,7 @@ client.folders.get_folder_by_id('0') - folder_id `str` - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" - 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 `?field=metadata.enterprise_12345.contractTemplate`. + - 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. - direction `Optional[GetFolderByIdDirection]` @@ -190,7 +190,7 @@ client.folders.get_folder_items(folder_origin.id) - folder_id `str` - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" - 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 `?field=metadata.enterprise_12345.contractTemplate`. + - 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`. - usemarker `Optional[bool]` - Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response. - marker `Optional[str]`