Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support additionalProperties of type any in Python and TS (box/box-codegen#453) #82

Merged
merged 4 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/file_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def create_file_metadata_by_id(
file_id: str,
scope: CreateFileMetadataByIdScope,
template_key: str,
request_body: Dict[str, str],
request_body: Dict,
*,
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> MetadataFull:
Expand Down Expand Up @@ -266,7 +266,7 @@ def create_file_metadata_by_id(
Example: "properties"
:type template_key: str
:param request_body: Request body of createFileMetadataById method
:type request_body: Dict[str, str]
:type request_body: Dict
: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
"""
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/folder_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ def create_folder_metadata_by_id(
folder_id: str,
scope: CreateFolderMetadataByIdScope,
template_key: str,
request_body: Dict[str, str],
request_body: Dict,
*,
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> MetadataFull:
Expand Down Expand Up @@ -290,7 +290,7 @@ def create_folder_metadata_by_id(
Example: "properties"
:type template_key: str
:param request_body: Request body of createFolderMetadataById method
:type request_body: Dict[str, str]
:type request_body: Dict
: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
"""
Expand Down
4 changes: 2 additions & 2 deletions box_sdk_gen/managers/metadata_templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def __init__(
self,
op: UpdateMetadataTemplateRequestBodyOpField,
*,
data: Optional[Dict[str, str]] = None,
data: Optional[Dict] = None,
field_key: Optional[str] = None,
field_keys: Optional[List[str]] = None,
enum_option_key: Optional[str] = None,
Expand All @@ -106,7 +106,7 @@ def __init__(
:type op: UpdateMetadataTemplateRequestBodyOpField
:param data: The data for the operation. This will vary depending on the
operation being performed., defaults to None
:type data: Optional[Dict[str, str]], optional
:type data: Optional[Dict], optional
:param field_key: For operations that affect a single field this defines the key of
the field that is affected., defaults to None
:type field_key: Optional[str], optional
Expand Down
2 changes: 1 addition & 1 deletion box_sdk_gen/schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -9072,7 +9072,7 @@ def __init__(
created_by: Optional[UserMini] = None,
event_type: Optional[EventEventTypeField] = None,
session_id: Optional[str] = None,
source: Optional[Union[User, EventSource, File, Folder, Dict[str, str]]] = None,
source: Optional[Union[User, EventSource, File, Folder, Dict]] = None,
additional_details: Optional[EventAdditionalDetailsField] = None,
**kwargs
):
Expand Down
2 changes: 1 addition & 1 deletion docs/file_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ client.file_metadata.create_file_metadata_by_id(file.id, CreateFileMetadataByIdS
- The scope of the metadata template Example: "global"
- template_key `str`
- The name of the metadata template Example: "properties"
- request_body `Dict[str, str]`
- request_body `Dict`
- Request body of createFileMetadataById method
- extra_headers `Optional[Dict[str, Optional[str]]]`
- Extra headers that will be included in the HTTP request.
Expand Down
4 changes: 2 additions & 2 deletions docs/folder_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ client.folder_metadata.create_folder_metadata_by_id(folder.id, CreateFolderMetad
- The scope of the metadata template Example: "global"
- template_key `str`
- The name of the metadata template Example: "properties"
- request_body `Dict[str, str]`
- request_body `Dict`
- Request body of createFolderMetadataById method
- extra_headers `Optional[Dict[str, Optional[str]]]`
- Extra headers that will be included in the HTTP request.
Expand Down Expand Up @@ -170,7 +170,7 @@ See the endpoint docs at
<!-- sample delete_folders_id_metadata_id_id -->

```python
client.folder_metadata.delete_folder_metadata_by_id(folder.id, DeleteFolderMetadataByIdScope.GLOBAL.value, 'properties')
client.folder_metadata.delete_folder_metadata_by_id(folder.id, DeleteFolderMetadataByIdScope.ENTERPRISE.value, template_key)
```

### Arguments
Expand Down
91 changes: 90 additions & 1 deletion test/file_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import pytest

from typing import List

from box_sdk_gen.client import BoxClient

from box_sdk_gen.schemas import FileFull
Expand All @@ -22,6 +24,20 @@

from box_sdk_gen.managers.file_metadata import DeleteFileMetadataByIdScope

from box_sdk_gen.schemas import MetadataTemplate

from box_sdk_gen.managers.metadata_templates import CreateMetadataTemplateFields

from box_sdk_gen.managers.metadata_templates import (
CreateMetadataTemplateFieldsTypeField,
)

from box_sdk_gen.managers.metadata_templates import (
CreateMetadataTemplateFieldsOptionsField,
)

from box_sdk_gen.managers.metadata_templates import DeleteMetadataTemplateScope

from box_sdk_gen.internal.utils import generate_byte_stream

from box_sdk_gen.internal.utils import get_uuid
Expand All @@ -33,7 +49,7 @@
client: BoxClient = get_default_client()


def testFileMetadata():
def testGlobalFileMetadata():
file: FileFull = upload_new_file()
file_metadata: Metadatas = client.file_metadata.get_file_metadata(file.id)
assert len(file_metadata.entries) == 0
Expand Down Expand Up @@ -74,3 +90,76 @@ def testFileMetadata():
file.id, GetFileMetadataByIdScope.GLOBAL.value, 'properties'
)
client.files.delete_file_by_id(file.id)


def testEnterpriseFileMetadata():
file: FileFull = upload_new_file()
template_key: str = ''.join(['key', get_uuid()])
template: MetadataTemplate = client.metadata_templates.create_metadata_template(
'enterprise',
template_key,
template_key=template_key,
fields=[
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.STRING.value,
key='name',
display_name='name',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.FLOAT.value,
key='age',
display_name='age',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.DATE.value,
key='birthDate',
display_name='birthDate',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.ENUM.value,
key='countryCode',
display_name='countryCode',
options=[
CreateMetadataTemplateFieldsOptionsField(key='US'),
CreateMetadataTemplateFieldsOptionsField(key='CA'),
],
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.MULTISELECT.value,
key='sports',
display_name='sports',
options=[
CreateMetadataTemplateFieldsOptionsField(key='basketball'),
CreateMetadataTemplateFieldsOptionsField(key='football'),
CreateMetadataTemplateFieldsOptionsField(key='tennis'),
],
),
],
)
created_metadata: MetadataFull = client.file_metadata.create_file_metadata_by_id(
file.id,
CreateFileMetadataByIdScope.ENTERPRISE.value,
template_key,
{
'name': 'John',
'age': 23,
'birthDate': '2001-01-03T02:20:50.520Z',
'countryCode': 'US',
'sports': ['basketball', 'tennis'],
},
)
assert to_string(created_metadata.template) == template_key
assert created_metadata.extra_data['name'] == 'John'
assert created_metadata.extra_data['age'] == 23
assert created_metadata.extra_data['birthDate'] == '2001-01-03T02:20:50.520Z'
assert created_metadata.extra_data['countryCode'] == 'US'
sports: List[str] = created_metadata.extra_data['sports']
assert sports[0] == 'basketball'
assert sports[1] == 'tennis'
client.file_metadata.delete_file_metadata_by_id(
file.id, DeleteFileMetadataByIdScope.ENTERPRISE.value, template_key
)
client.metadata_templates.delete_metadata_template(
DeleteMetadataTemplateScope.ENTERPRISE.value, template_key
)
client.files.delete_file_by_id(file.id)
93 changes: 92 additions & 1 deletion test/folder_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import pytest

from typing import List

from box_sdk_gen.client import BoxClient

from box_sdk_gen.schemas import FolderFull
Expand All @@ -24,6 +26,20 @@

from box_sdk_gen.managers.folder_metadata import DeleteFolderMetadataByIdScope

from box_sdk_gen.schemas import MetadataTemplate

from box_sdk_gen.managers.metadata_templates import CreateMetadataTemplateFields

from box_sdk_gen.managers.metadata_templates import (
CreateMetadataTemplateFieldsTypeField,
)

from box_sdk_gen.managers.metadata_templates import (
CreateMetadataTemplateFieldsOptionsField,
)

from box_sdk_gen.managers.metadata_templates import DeleteMetadataTemplateScope

from box_sdk_gen.internal.utils import get_uuid

from test.commons import get_default_client
Expand All @@ -33,7 +49,7 @@
client: BoxClient = get_default_client()


def testFolderMetadata():
def testGlobalFolderMetadata():
folder: FolderFull = create_new_folder()
folder_metadata: Metadatas = client.folder_metadata.get_folder_metadata(folder.id)
assert len(folder_metadata.entries) == 0
Expand Down Expand Up @@ -81,3 +97,78 @@ def testFolderMetadata():
folder.id, GetFolderMetadataByIdScope.GLOBAL.value, 'properties'
)
client.folders.delete_folder_by_id(folder.id)


def testEnterpriseFolderMetadata():
folder: FolderFull = create_new_folder()
template_key: str = ''.join(['key', get_uuid()])
template: MetadataTemplate = client.metadata_templates.create_metadata_template(
'enterprise',
template_key,
template_key=template_key,
fields=[
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.STRING.value,
key='name',
display_name='name',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.FLOAT.value,
key='age',
display_name='age',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.DATE.value,
key='birthDate',
display_name='birthDate',
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.ENUM.value,
key='countryCode',
display_name='countryCode',
options=[
CreateMetadataTemplateFieldsOptionsField(key='US'),
CreateMetadataTemplateFieldsOptionsField(key='CA'),
],
),
CreateMetadataTemplateFields(
type=CreateMetadataTemplateFieldsTypeField.MULTISELECT.value,
key='sports',
display_name='sports',
options=[
CreateMetadataTemplateFieldsOptionsField(key='basketball'),
CreateMetadataTemplateFieldsOptionsField(key='football'),
CreateMetadataTemplateFieldsOptionsField(key='tennis'),
],
),
],
)
created_metadata: MetadataFull = (
client.folder_metadata.create_folder_metadata_by_id(
folder.id,
CreateFolderMetadataByIdScope.ENTERPRISE.value,
template_key,
{
'name': 'John',
'age': 23,
'birthDate': '2001-01-03T02:20:50.520Z',
'countryCode': 'US',
'sports': ['basketball', 'tennis'],
},
)
)
assert to_string(created_metadata.template) == template_key
assert created_metadata.extra_data['name'] == 'John'
assert created_metadata.extra_data['age'] == 23
assert created_metadata.extra_data['birthDate'] == '2001-01-03T02:20:50.520Z'
assert created_metadata.extra_data['countryCode'] == 'US'
sports: List[str] = created_metadata.extra_data['sports']
assert sports[0] == 'basketball'
assert sports[1] == 'tennis'
client.folder_metadata.delete_folder_metadata_by_id(
folder.id, DeleteFolderMetadataByIdScope.ENTERPRISE.value, template_key
)
client.metadata_templates.delete_metadata_template(
DeleteMetadataTemplateScope.ENTERPRISE.value, template_key
)
client.folders.delete_folder_by_id(folder.id)
Loading