frameio 0.0.23__py3-none-any.whl

frameio/folders/types/__init__.py

@@ -0,0 +1,42 @@
+# 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 .folder_copy_params_data import FolderCopyParamsData
+    from .folder_create_params_data import FolderCreateParamsData
+    from .folder_move_params_data import FolderMoveParamsData
+    from .folder_update_params_data import FolderUpdateParamsData
+_dynamic_imports: typing.Dict[str, str] = {
+    "FolderCopyParamsData": ".folder_copy_params_data",
+    "FolderCreateParamsData": ".folder_create_params_data",
+    "FolderMoveParamsData": ".folder_move_params_data",
+    "FolderUpdateParamsData": ".folder_update_params_data",
+}
+
+
+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__ = ["FolderCopyParamsData", "FolderCreateParamsData", "FolderMoveParamsData", "FolderUpdateParamsData"]

frameio/folders/types/folder_copy_params_data.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import UniversalBaseModel
+
+
+class FolderCopyParamsData(UniversalBaseModel):
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination folder ID. Defaults to folder parent ID.
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/folders/types/folder_create_params_data.py

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

frameio/folders/types/folder_move_params_data.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import UniversalBaseModel
+
+
+class FolderMoveParamsData(UniversalBaseModel):
+    parent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination folder ID
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

frameio/folders/types/folder_update_params_data.py

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

frameio/metadata/__init__.py

@@ -0,0 +1,37 @@
+# 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 BulkUpdateMetadataParamsData, BulkUpdateMetadataParamsDataValuesItem
+_dynamic_imports: typing.Dict[str, str] = {
+    "BulkUpdateMetadataParamsData": ".types",
+    "BulkUpdateMetadataParamsDataValuesItem": ".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__ = ["BulkUpdateMetadataParamsData", "BulkUpdateMetadataParamsDataValuesItem"]

frameio/metadata/client.py

@@ -0,0 +1,291 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.metadata_response import MetadataResponse
+from ..types.uuid_ import Uuid
+from .raw_client import AsyncRawMetadataClient, RawMetadataClient
+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 MetadataClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawMetadataClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawMetadataClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawMetadataClient
+        """
+        return self._raw_client
+
+    def bulk_update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: BulkUpdateMetadataParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> 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
+        -------
+        None
+
+        Examples
+        --------
+        from frameio import Frameio
+        from frameio.metadata import (
+            BulkUpdateMetadataParamsData,
+            BulkUpdateMetadataParamsDataValuesItem,
+        )
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.metadata.bulk_update(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            data=BulkUpdateMetadataParamsData(
+                file_ids=[
+                    "90d56890-76ff-46f0-ba5c-4e3c6eea01e1",
+                    "2a20ca3b-b124-4b5e-acc4-51f03dbf10ab",
+                ],
+                values=[
+                    BulkUpdateMetadataParamsDataValuesItem(
+                        field_definition_id="8d4fa2a4-83e1-4adc-81eb-2f10e4f52cc0",
+                        value="active",
+                    ),
+                    BulkUpdateMetadataParamsDataValuesItem(
+                        field_definition_id="deca9ec9-9ecb-457c-9c05-fee6d5cfb4dc",
+                        value=5,
+                    ),
+                    BulkUpdateMetadataParamsDataValuesItem(
+                        field_definition_id="ecf44d7b-68b7-4ef7-9fb6-3f43bf7c1c25",
+                        value="1e6be645-bf76-4914-9de9-c567be3ee2a4",
+                    ),
+                ],
+            ),
+        )
+        """
+        _response = self._raw_client.bulk_update(account_id, project_id, data=data, request_options=request_options)
+        return _response.data
+
+    def show(
+        self,
+        account_id: Uuid,
+        file_id: Uuid,
+        *,
+        show_null: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> 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
+        -------
+        MetadataResponse
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.metadata.show(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            show_null=True,
+        )
+        """
+        _response = self._raw_client.show(account_id, file_id, show_null=show_null, request_options=request_options)
+        return _response.data
+
+
+class AsyncMetadataClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawMetadataClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawMetadataClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawMetadataClient
+        """
+        return self._raw_client
+
+    async def bulk_update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: BulkUpdateMetadataParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> 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
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+        from frameio.metadata import (
+            BulkUpdateMetadataParamsData,
+            BulkUpdateMetadataParamsDataValuesItem,
+        )
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.metadata.bulk_update(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                data=BulkUpdateMetadataParamsData(
+                    file_ids=[
+                        "90d56890-76ff-46f0-ba5c-4e3c6eea01e1",
+                        "2a20ca3b-b124-4b5e-acc4-51f03dbf10ab",
+                    ],
+                    values=[
+                        BulkUpdateMetadataParamsDataValuesItem(
+                            field_definition_id="8d4fa2a4-83e1-4adc-81eb-2f10e4f52cc0",
+                            value="active",
+                        ),
+                        BulkUpdateMetadataParamsDataValuesItem(
+                            field_definition_id="deca9ec9-9ecb-457c-9c05-fee6d5cfb4dc",
+                            value=5,
+                        ),
+                        BulkUpdateMetadataParamsDataValuesItem(
+                            field_definition_id="ecf44d7b-68b7-4ef7-9fb6-3f43bf7c1c25",
+                            value="1e6be645-bf76-4914-9de9-c567be3ee2a4",
+                        ),
+                    ],
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.bulk_update(
+            account_id, project_id, data=data, request_options=request_options
+        )
+        return _response.data
+
+    async def show(
+        self,
+        account_id: Uuid,
+        file_id: Uuid,
+        *,
+        show_null: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> 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
+        -------
+        MetadataResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.metadata.show(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                show_null=True,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.show(
+            account_id, file_id, show_null=show_null, request_options=request_options
+        )
+        return _response.data