frameio 0.0.28__py3-none-any.whl

frameio/account_permissions/__init__.py

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

frameio/account_permissions/client.py

@@ -0,0 +1,193 @@
+# 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.account_user_role import AccountUserRole
+from ..types.account_user_roles_response import AccountUserRolesResponse
+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 .raw_client import AsyncRawAccountPermissionsClient, RawAccountPermissionsClient
+
+
+class AccountPermissionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAccountPermissionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAccountPermissionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAccountPermissionsClient
+        """
+        return self._raw_client
+
+    def index(
+        self,
+        account_id: Uuid,
+        *,
+        include_deactivated: typing.Optional[bool] = 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[AccountUserRole, AccountUserRolesResponse]:
+        """
+        List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include_deactivated : typing.Optional[bool]
+            Supports including deactivated users in the response. Default is false.
+
+        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[AccountUserRole, AccountUserRolesResponse]
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        response = client.account_permissions.index(
+            account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+            include_deactivated=True,
+            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_deactivated=include_deactivated,
+            after=after,
+            page_size=page_size,
+            include_total_count=include_total_count,
+            request_options=request_options,
+        )
+
+
+class AsyncAccountPermissionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAccountPermissionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAccountPermissionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAccountPermissionsClient
+        """
+        return self._raw_client
+
+    async def index(
+        self,
+        account_id: Uuid,
+        *,
+        include_deactivated: typing.Optional[bool] = 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[AccountUserRole, AccountUserRolesResponse]:
+        """
+        List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include_deactivated : typing.Optional[bool]
+            Supports including deactivated users in the response. Default is false.
+
+        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[AccountUserRole, AccountUserRolesResponse]
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            response = await client.account_permissions.index(
+                account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
+                include_deactivated=True,
+                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_deactivated=include_deactivated,
+            after=after,
+            page_size=page_size,
+            include_total_count=include_total_count,
+            request_options=request_options,
+        )

frameio/account_permissions/raw_client.py

@@ -0,0 +1,333 @@
+# 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.jsonable_encoder import jsonable_encoder
+from ..core.pagination import AsyncPager, SyncPager
+from ..core.request_options import RequestOptions
+from ..core.unchecked_base_model import construct_type
+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.account_user_role import AccountUserRole
+from ..types.account_user_roles_response import AccountUserRolesResponse
+from ..types.bad_request import BadRequest
+from ..types.forbidden import Forbidden
+from ..types.include_total_count import IncludeTotalCount
+from ..types.not_found import NotFound
+from ..types.request_after_opaque_cursor import RequestAfterOpaqueCursor
+from ..types.request_page_size import RequestPageSize
+from ..types.too_many_requests import TooManyRequests
+from ..types.unauthorized import Unauthorized
+from ..types.uuid_ import Uuid
+
+
+class RawAccountPermissionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def index(
+        self,
+        account_id: Uuid,
+        *,
+        include_deactivated: typing.Optional[bool] = 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[AccountUserRole, AccountUserRolesResponse]:
+        """
+        List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include_deactivated : typing.Optional[bool]
+            Supports including deactivated users in the response. Default is false.
+
+        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[AccountUserRole, AccountUserRolesResponse]
+            OK
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/users",
+            method="GET",
+            params={
+                "include_deactivated": include_deactivated,
+                "after": after,
+                "page_size": page_size,
+                "include_total_count": include_total_count,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = typing.cast(
+                    AccountUserRolesResponse,
+                    construct_type(
+                        type_=AccountUserRolesResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                _items = _parsed_response.data
+                _has_next = False
+                _get_next = None
+                if _parsed_response.links is not None:
+                    _parsed_next = _parsed_response.links.next
+                    _has_next = _parsed_next is not None and _parsed_next != ""
+                    _get_next = lambda: self.index(
+                        account_id,
+                        include_deactivated=include_deactivated,
+                        after=_parsed_next,
+                        page_size=page_size,
+                        include_total_count=include_total_count,
+                        request_options=request_options,
+                    )
+                return SyncPager(has_next=_has_next, items=_items, get_next=_get_next, response=_parsed_response)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        construct_type(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        construct_type(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        construct_type(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        construct_type(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        construct_type(
+                            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 AsyncRawAccountPermissionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def index(
+        self,
+        account_id: Uuid,
+        *,
+        include_deactivated: typing.Optional[bool] = 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[AccountUserRole, AccountUserRolesResponse]:
+        """
+        List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        account_id : Uuid
+
+
+        include_deactivated : typing.Optional[bool]
+            Supports including deactivated users in the response. Default is false.
+
+        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[AccountUserRole, AccountUserRolesResponse]
+            OK
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v4/accounts/{jsonable_encoder(account_id)}/users",
+            method="GET",
+            params={
+                "include_deactivated": include_deactivated,
+                "after": after,
+                "page_size": page_size,
+                "include_total_count": include_total_count,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = typing.cast(
+                    AccountUserRolesResponse,
+                    construct_type(
+                        type_=AccountUserRolesResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                _items = _parsed_response.data
+                _has_next = False
+                _get_next = None
+                if _parsed_response.links is not None:
+                    _parsed_next = _parsed_response.links.next
+                    _has_next = _parsed_next is not None and _parsed_next != ""
+
+                    async def _get_next():
+                        return await self.index(
+                            account_id,
+                            include_deactivated=include_deactivated,
+                            after=_parsed_next,
+                            page_size=page_size,
+                            include_total_count=include_total_count,
+                            request_options=request_options,
+                        )
+
+                return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next, response=_parsed_response)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        BadRequest,
+                        construct_type(
+                            type_=BadRequest,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Unauthorized,
+                        construct_type(
+                            type_=Unauthorized,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Forbidden,
+                        construct_type(
+                            type_=Forbidden,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFound,
+                        construct_type(
+                            type_=NotFound,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        TooManyRequests,
+                        construct_type(
+                            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/accounts/__init__.py

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

frameio/accounts/client.py

@@ -0,0 +1,162 @@
+# 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.account import Account
+from ..types.accounts_response import AccountsResponse
+from ..types.include_total_count import IncludeTotalCount
+from ..types.request_after_opaque_cursor import RequestAfterOpaqueCursor
+from ..types.request_page_size import RequestPageSize
+from .raw_client import AsyncRawAccountsClient, RawAccountsClient
+
+
+class AccountsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAccountsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAccountsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAccountsClient
+        """
+        return self._raw_client
+
+    def index(
+        self,
+        *,
+        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[Account, AccountsResponse]:
+        """
+        List accounts for the current user. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        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[Account, AccountsResponse]
+            OK
+
+        Examples
+        --------
+        from frameio import Frameio
+
+        client = Frameio(
+            token="YOUR_TOKEN",
+        )
+        response = client.accounts.index(
+            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(
+            after=after, page_size=page_size, include_total_count=include_total_count, request_options=request_options
+        )
+
+
+class AsyncAccountsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAccountsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAccountsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAccountsClient
+        """
+        return self._raw_client
+
+    async def index(
+        self,
+        *,
+        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[Account, AccountsResponse]:
+        """
+        List accounts for the current user. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+
+        Parameters
+        ----------
+        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[Account, AccountsResponse]
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from frameio import AsyncFrameio
+
+        client = AsyncFrameio(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            response = await client.accounts.index(
+                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(
+            after=after, page_size=page_size, include_total_count=include_total_count, request_options=request_options
+        )