frameio 0.0.28__py3-none-any.whl

frameio/projects/__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 .types import ProjectParamsData, ProjectUpdateParamsData, ProjectUpdateParamsDataStatus
+_dynamic_imports: typing.Dict[str, str] = {
+    "ProjectParamsData": ".types",
+    "ProjectUpdateParamsData": ".types",
+    "ProjectUpdateParamsDataStatus": ".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__ = ["ProjectParamsData", "ProjectUpdateParamsData", "ProjectUpdateParamsDataStatus"]

frameio/projects/client.py

@@ -0,0 +1,604 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
+from ..core.request_options import RequestOptions
+from ..types.include_total_count import IncludeTotalCount
+from ..types.project_response import ProjectResponse
+from ..types.project_with_includes import ProjectWithIncludes
+from ..types.project_with_includes_response import ProjectWithIncludesResponse
+from ..types.projects_with_includes_response import ProjectsWithIncludesResponse
+from ..types.request_after_opaque_cursor import RequestAfterOpaqueCursor
+from ..types.request_page_size import RequestPageSize
+from ..types.uuid_ import Uuid
+from .raw_client import AsyncRawProjectsClient, RawProjectsClient
+from .types.project_params_data import ProjectParamsData
+from .types.project_update_params_data import ProjectUpdateParamsData
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ProjectsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawProjectsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawProjectsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawProjectsClient
+        """
+        return self._raw_client
+
+    def show(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["owner"]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectWithIncludesResponse:
+        """
+        Show project details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["owner"]]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectWithIncludesResponse
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.projects.show(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+        )
+        """
+        _response = self._raw_client.show(account_id, project_id, include=include, request_options=request_options)
+        return _response.data
+
+    def delete(
+        self, account_id: Uuid, project_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete a project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.projects.delete(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+        )
+        """
+        _response = self._raw_client.delete(account_id, project_id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: ProjectUpdateParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectResponse:
+        """
+        Update project details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        data : ProjectUpdateParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectResponse
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+        from frameio.projects import ProjectUpdateParamsData
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.projects.update(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            data=ProjectUpdateParamsData(
+                name="Project Name",
+                restricted=True,
+                status="active",
+            ),
+        )
+        """
+        _response = self._raw_client.update(account_id, project_id, data=data, request_options=request_options)
+        return _response.data
+
+    def index(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["owner"]] = None,
+        after: typing.Optional[RequestAfterOpaqueCursor] = None,
+        page_size: typing.Optional[RequestPageSize] = None,
+        include_total_count: typing.Optional[IncludeTotalCount] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SyncPager[ProjectWithIncludes, ProjectsWithIncludesResponse]:
+        """
+        List projects in a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["owner"]]
+
+
+        after : typing.Optional[RequestAfterOpaqueCursor]
+            Opaque Cursor query param for requests returning paginated results.
+            <br/>
+            NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
+
+        page_size : typing.Optional[RequestPageSize]
+
+
+        include_total_count : typing.Optional[IncludeTotalCount]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SyncPager[ProjectWithIncludes, ProjectsWithIncludesResponse]
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        response = client.projects.index(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            after="<opaque_cursor>",
+            page_size=10,
+            include_total_count=False,
+        )
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
+        """
+        return self._raw_client.index(
+            account_id,
+            workspace_id,
+            include=include,
+            after=after,
+            page_size=page_size,
+            include_total_count=include_total_count,
+            request_options=request_options,
+        )
+
+    def create(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        data: ProjectParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectResponse:
+        """
+        Create project in a given workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        data : ProjectParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectResponse
+            Created
+
+        Examples
+        --------
+        from frameio import Frameio
+        from frameio.projects import ProjectParamsData
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.projects.create(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            data=ProjectParamsData(
+                name="Project Name",
+                restricted=True,
+            ),
+        )
+        """
+        _response = self._raw_client.create(account_id, workspace_id, data=data, request_options=request_options)
+        return _response.data
+
+
+class AsyncProjectsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawProjectsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawProjectsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawProjectsClient
+        """
+        return self._raw_client
+
+    async def show(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["owner"]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectWithIncludesResponse:
+        """
+        Show project details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["owner"]]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectWithIncludesResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.projects.show(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.show(
+            account_id, project_id, include=include, request_options=request_options
+        )
+        return _response.data
+
+    async def delete(
+        self, account_id: Uuid, project_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete a project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.projects.delete(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(account_id, project_id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        account_id: Uuid,
+        project_id: Uuid,
+        *,
+        data: ProjectUpdateParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectResponse:
+        """
+        Update project details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        project_id : Uuid
+
+
+        data : ProjectUpdateParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+        from frameio.projects import ProjectUpdateParamsData
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.projects.update(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                data=ProjectUpdateParamsData(
+                    name="Project Name",
+                    restricted=True,
+                    status="active",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(account_id, project_id, data=data, request_options=request_options)
+        return _response.data
+
+    async def index(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["owner"]] = None,
+        after: typing.Optional[RequestAfterOpaqueCursor] = None,
+        page_size: typing.Optional[RequestPageSize] = None,
+        include_total_count: typing.Optional[IncludeTotalCount] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncPager[ProjectWithIncludes, ProjectsWithIncludesResponse]:
+        """
+        List projects in a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["owner"]]
+
+
+        after : typing.Optional[RequestAfterOpaqueCursor]
+            Opaque Cursor query param for requests returning paginated results.
+            <br/>
+            NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
+
+        page_size : typing.Optional[RequestPageSize]
+
+
+        include_total_count : typing.Optional[IncludeTotalCount]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncPager[ProjectWithIncludes, ProjectsWithIncludesResponse]
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            response = await client.projects.index(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                after="<opaque_cursor>",
+                page_size=10,
+                include_total_count=False,
+            )
+            async for item in response:
+                yield item
+
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
+
+
+        asyncio.run(main())
+        """
+        return await self._raw_client.index(
+            account_id,
+            workspace_id,
+            include=include,
+            after=after,
+            page_size=page_size,
+            include_total_count=include_total_count,
+            request_options=request_options,
+        )
+
+    async def create(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        data: ProjectParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProjectResponse:
+        """
+        Create project in a given workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        data : ProjectParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectResponse
+            Created
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+        from frameio.projects import ProjectParamsData
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.projects.create(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                data=ProjectParamsData(
+                    name="Project Name",
+                    restricted=True,
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(account_id, workspace_id, data=data, request_options=request_options)
+        return _response.data