frameio 0.0.23__py3-none-any.whl

frameio/metadata/raw_client.py

@@ -0,0 +1,509 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.not_found_error import NotFoundError
+from ..errors.too_many_requests_error import TooManyRequestsError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.bad_request import BadRequest
+from ..types.forbidden import Forbidden
+from ..types.metadata_response import MetadataResponse
+from ..types.not_found import NotFound
+from ..types.too_many_requests import TooManyRequests
+from ..types.unauthorized import Unauthorized
+from ..types.uuid_ import Uuid
+from .types.bulk_update_metadata_params_data import BulkUpdateMetadataParamsData
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawMetadataClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def bulk_update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: BulkUpdateMetadataParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[None]:
+        """
+        Update metadata values across multiple files. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        data : BulkUpdateMetadataParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/projects/{jsonable_encoder(project_id)}/metadata/values",
+            method="PATCH",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=BulkUpdateMetadataParamsData, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        parse_obj_as(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        parse_obj_as(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        parse_obj_as(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        parse_obj_as(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        parse_obj_as(
+                            type_=TooManyRequests,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def show(
+        self,
+        account_id: Uuid,
+        file_id: Uuid,
+        *,
+        show_null: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[MetadataResponse]:
+        """
+        Show the metadata of a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        file_id : Uuid
+
+
+        show_null : typing.Optional[bool]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[MetadataResponse]
+            OK
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/files/{jsonable_encoder(file_id)}/metadata",
+            method="GET",
+            params={
+                "show_null": show_null,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    MetadataResponse,
+                    parse_obj_as(
+                        type_=MetadataResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        parse_obj_as(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        parse_obj_as(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        parse_obj_as(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        parse_obj_as(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        parse_obj_as(
+                            type_=TooManyRequests,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawMetadataClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def bulk_update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: BulkUpdateMetadataParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[None]:
+        """
+        Update metadata values across multiple files. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        data : BulkUpdateMetadataParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/projects/{jsonable_encoder(project_id)}/metadata/values",
+            method="PATCH",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=BulkUpdateMetadataParamsData, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        parse_obj_as(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        parse_obj_as(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        parse_obj_as(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        parse_obj_as(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        parse_obj_as(
+                            type_=TooManyRequests,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def show(
+        self,
+        account_id: Uuid,
+        file_id: Uuid,
+        *,
+        show_null: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[MetadataResponse]:
+        """
+        Show the metadata of a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        file_id : Uuid
+
+
+        show_null : typing.Optional[bool]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[MetadataResponse]
+            OK
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/files/{jsonable_encoder(file_id)}/metadata",
+            method="GET",
+            params={
+                "show_null": show_null,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    MetadataResponse,
+                    parse_obj_as(
+                        type_=MetadataResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        parse_obj_as(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        parse_obj_as(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        parse_obj_as(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        parse_obj_as(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        parse_obj_as(
+                            type_=TooManyRequests,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

frameio/metadata/types/__init__.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .bulk_update_metadata_params_data import BulkUpdateMetadataParamsData
+    from .bulk_update_metadata_params_data_values_item import BulkUpdateMetadataParamsDataValuesItem
+_dynamic_imports: typing.Dict[str, str] = {
+    "BulkUpdateMetadataParamsData": ".bulk_update_metadata_params_data",
+    "BulkUpdateMetadataParamsDataValuesItem": ".bulk_update_metadata_params_data_values_item",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["BulkUpdateMetadataParamsData", "BulkUpdateMetadataParamsDataValuesItem"]

frameio/metadata/types/bulk_update_metadata_params_data.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import UniversalBaseModel
+from ...types.uuid_ import Uuid
+from .bulk_update_metadata_params_data_values_item import BulkUpdateMetadataParamsDataValuesItem
+
+
+class BulkUpdateMetadataParamsData(UniversalBaseModel):
+    file_ids: typing.List[Uuid] = pydantic.Field()
+    """
+    Files for bulk updates
+    """
+
+    values: typing.List[BulkUpdateMetadataParamsDataValuesItem] = pydantic.Field()
+    """
+    Metadata field and value mapping params. 
+    Note: Select and MultiSelect field values should be passed as lists, eg: [<uuid>]. Users and MultiUser values should be passed as lists formatted as follows: [%{id: <user_id>, type: "user"}, %{id: <user_group_id>, type: "account_user_group"}
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/metadata/types/bulk_update_metadata_params_data_values_item.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import UniversalBaseModel
+
+
+class BulkUpdateMetadataParamsDataValuesItem(UniversalBaseModel):
+    field_definition_id: str
+    value: typing.Optional[typing.Any] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/metadata_fields/__init__.py

@@ -0,0 +1,103 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        CreateFieldDefinitionParamsData,
+        CreateFieldDefinitionParamsData_Date,
+        CreateFieldDefinitionParamsData_LongText,
+        CreateFieldDefinitionParamsData_Number,
+        CreateFieldDefinitionParamsData_Rating,
+        CreateFieldDefinitionParamsData_Select,
+        CreateFieldDefinitionParamsData_SelectMulti,
+        CreateFieldDefinitionParamsData_Text,
+        CreateFieldDefinitionParamsData_Toggle,
+        CreateFieldDefinitionParamsData_UserMulti,
+        CreateFieldDefinitionParamsData_UserSingle,
+        UpdateFieldDefinitionParamsData,
+        UpdateFieldDefinitionParamsData_Date,
+        UpdateFieldDefinitionParamsData_LongText,
+        UpdateFieldDefinitionParamsData_Number,
+        UpdateFieldDefinitionParamsData_Rating,
+        UpdateFieldDefinitionParamsData_Select,
+        UpdateFieldDefinitionParamsData_SelectMulti,
+        UpdateFieldDefinitionParamsData_Text,
+        UpdateFieldDefinitionParamsData_Toggle,
+        UpdateFieldDefinitionParamsData_UserMulti,
+        UpdateFieldDefinitionParamsData_UserSingle,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateFieldDefinitionParamsData": ".types",
+    "CreateFieldDefinitionParamsData_Date": ".types",
+    "CreateFieldDefinitionParamsData_LongText": ".types",
+    "CreateFieldDefinitionParamsData_Number": ".types",
+    "CreateFieldDefinitionParamsData_Rating": ".types",
+    "CreateFieldDefinitionParamsData_Select": ".types",
+    "CreateFieldDefinitionParamsData_SelectMulti": ".types",
+    "CreateFieldDefinitionParamsData_Text": ".types",
+    "CreateFieldDefinitionParamsData_Toggle": ".types",
+    "CreateFieldDefinitionParamsData_UserMulti": ".types",
+    "CreateFieldDefinitionParamsData_UserSingle": ".types",
+    "UpdateFieldDefinitionParamsData": ".types",
+    "UpdateFieldDefinitionParamsData_Date": ".types",
+    "UpdateFieldDefinitionParamsData_LongText": ".types",
+    "UpdateFieldDefinitionParamsData_Number": ".types",
+    "UpdateFieldDefinitionParamsData_Rating": ".types",
+    "UpdateFieldDefinitionParamsData_Select": ".types",
+    "UpdateFieldDefinitionParamsData_SelectMulti": ".types",
+    "UpdateFieldDefinitionParamsData_Text": ".types",
+    "UpdateFieldDefinitionParamsData_Toggle": ".types",
+    "UpdateFieldDefinitionParamsData_UserMulti": ".types",
+    "UpdateFieldDefinitionParamsData_UserSingle": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CreateFieldDefinitionParamsData",
+    "CreateFieldDefinitionParamsData_Date",
+    "CreateFieldDefinitionParamsData_LongText",
+    "CreateFieldDefinitionParamsData_Number",
+    "CreateFieldDefinitionParamsData_Rating",
+    "CreateFieldDefinitionParamsData_Select",
+    "CreateFieldDefinitionParamsData_SelectMulti",
+    "CreateFieldDefinitionParamsData_Text",
+    "CreateFieldDefinitionParamsData_Toggle",
+    "CreateFieldDefinitionParamsData_UserMulti",
+    "CreateFieldDefinitionParamsData_UserSingle",
+    "UpdateFieldDefinitionParamsData",
+    "UpdateFieldDefinitionParamsData_Date",
+    "UpdateFieldDefinitionParamsData_LongText",
+    "UpdateFieldDefinitionParamsData_Number",
+    "UpdateFieldDefinitionParamsData_Rating",
+    "UpdateFieldDefinitionParamsData_Select",
+    "UpdateFieldDefinitionParamsData_SelectMulti",
+    "UpdateFieldDefinitionParamsData_Text",
+    "UpdateFieldDefinitionParamsData_Toggle",
+    "UpdateFieldDefinitionParamsData_UserMulti",
+    "UpdateFieldDefinitionParamsData_UserSingle",
+]