frameio 0.0.28__py3-none-any.whl

frameio/workspaces/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

frameio/workspaces/client.py

@@ -0,0 +1,563 @@
+# 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.request_after_opaque_cursor import RequestAfterOpaqueCursor
+from ..types.request_page_size import RequestPageSize
+from ..types.uuid_ import Uuid
+from ..types.workspace_params_data import WorkspaceParamsData
+from ..types.workspace_response import WorkspaceResponse
+from ..types.workspace_with_includes import WorkspaceWithIncludes
+from ..types.workspace_with_includes_response import WorkspaceWithIncludesResponse
+from ..types.workspaces_with_includes_response import WorkspacesWithIncludesResponse
+from .raw_client import AsyncRawWorkspacesClient, RawWorkspacesClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WorkspacesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWorkspacesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWorkspacesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWorkspacesClient
+        """
+        return self._raw_client
+
+    def show(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["creator"]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceWithIncludesResponse:
+        """
+        Show workspace details. <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["creator"]]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceWithIncludesResponse
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.workspaces.show(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+        )
+        """
+        _response = self._raw_client.show(account_id, workspace_id, include=include, request_options=request_options)
+        return _response.data
+
+    def delete(
+        self, account_id: Uuid, workspace_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete workspace from account. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.workspaces.delete(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+        )
+        """
+        _response = self._raw_client.delete(account_id, workspace_id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        data: WorkspaceParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceResponse:
+        """
+        Update a workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        data : WorkspaceParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceResponse
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio, WorkspaceParamsData
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.workspaces.update(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            data=WorkspaceParamsData(
+                name="My Workspace",
+            ),
+        )
+        """
+        _response = self._raw_client.update(account_id, workspace_id, data=data, request_options=request_options)
+        return _response.data
+
+    def index(
+        self,
+        account_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["creator"]] = 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[WorkspaceWithIncludes, WorkspacesWithIncludesResponse]:
+        """
+        List workspaces for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["creator"]]
+
+
+        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[WorkspaceWithIncludes, WorkspacesWithIncludesResponse]
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        response = client.workspaces.index(
+            account_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,
+            include=include,
+            after=after,
+            page_size=page_size,
+            include_total_count=include_total_count,
+            request_options=request_options,
+        )
+
+    def create(
+        self, account_id: Uuid, *, data: WorkspaceParamsData, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkspaceResponse:
+        """
+        Create workspace from an account. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        data : WorkspaceParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceResponse
+            Created
+
+        Examples
+        --------
+        from frameio import Frameio, WorkspaceParamsData
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        client.workspaces.create(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            data=WorkspaceParamsData(
+                name="My Workspace",
+            ),
+        )
+        """
+        _response = self._raw_client.create(account_id, data=data, request_options=request_options)
+        return _response.data
+
+
+class AsyncWorkspacesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWorkspacesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWorkspacesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWorkspacesClient
+        """
+        return self._raw_client
+
+    async def show(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["creator"]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceWithIncludesResponse:
+        """
+        Show workspace details. <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["creator"]]
+
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceWithIncludesResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.workspaces.show(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.show(
+            account_id, workspace_id, include=include, request_options=request_options
+        )
+        return _response.data
+
+    async def delete(
+        self, account_id: Uuid, workspace_id: Uuid, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Delete workspace from account. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_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.workspaces.delete(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(account_id, workspace_id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        account_id: Uuid,
+        workspace_id: Uuid,
+        *,
+        data: WorkspaceParamsData,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkspaceResponse:
+        """
+        Update a workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        workspace_id : Uuid
+
+
+        data : WorkspaceParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio, WorkspaceParamsData
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.workspaces.update(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                data=WorkspaceParamsData(
+                    name="My Workspace",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(account_id, workspace_id, data=data, request_options=request_options)
+        return _response.data
+
+    async def index(
+        self,
+        account_id: Uuid,
+        *,
+        include: typing.Optional[typing.Literal["creator"]] = 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[WorkspaceWithIncludes, WorkspacesWithIncludesResponse]:
+        """
+        List workspaces for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include : typing.Optional[typing.Literal["creator"]]
+
+
+        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[WorkspaceWithIncludes, WorkspacesWithIncludesResponse]
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            response = await client.workspaces.index(
+                account_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,
+            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, *, data: WorkspaceParamsData, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkspaceResponse:
+        """
+        Create workspace from an account. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        data : WorkspaceParamsData
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkspaceResponse
+            Created
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio, WorkspaceParamsData
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.workspaces.create(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                data=WorkspaceParamsData(
+                    name="My Workspace",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(account_id, data=data, request_options=request_options)
+        return _response.data