client.py

# 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.tenant_feature import TenantFeature
from ..types.tenants_create200response import TenantsCreate200Response
from ..types.tenants_get200response import TenantsGet200Response
from ..types.tenants_list200response import TenantsList200Response
from ..types.tenants_update200response import TenantsUpdate200Response
from ..types.tenants_usage200response import TenantsUsage200Response
from .raw_client import AsyncRawTenantsClient, RawTenantsClient

# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)


class TenantsClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawTenantsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> RawTenantsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        RawTenantsClient
        """
        return self._raw_client

    def list(
        self,
        *,
        limit: typing.Optional[int] = None,
        cursor: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsList200Response:
        """
        Parameters
        ----------
        limit : typing.Optional[int]

        cursor : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsList200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.list()
        """
        _response = self._raw_client.list(limit=limit, cursor=cursor, request_options=request_options)
        return _response.data

    def create(
        self, *, id: str, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
    ) -> TenantsCreate200Response:
        """
        Parameters
        ----------
        id : str

        name : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsCreate200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.create(
            id="id",
        )
        """
        _response = self._raw_client.create(id=id, name=name, request_options=request_options)
        return _response.data

    def get(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> TenantsGet200Response:
        """
        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsGet200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.get(
            tenant_id="tenantId",
        )
        """
        _response = self._raw_client.get(tenant_id, request_options=request_options)
        return _response.data

    def delete(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
        """
        Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.

        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.delete(
            tenant_id="tenantId",
        )
        """
        _response = self._raw_client.delete(tenant_id, request_options=request_options)
        return _response.data

    def update(
        self,
        tenant_id: str,
        *,
        features: typing.Sequence[TenantFeature],
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsUpdate200Response:
        """
        A feature names an installed module; any other id is a 400. A module route answers a tenant without its feature 403 FeatureNotEnabled, and one whose feature is stopped 402 FeatureStopped (details.feature, details.stopped). Other replicas apply a change within 30 seconds.

        Parameters
        ----------
        tenant_id : str

        features : typing.Sequence[TenantFeature]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsUpdate200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient, TenantFeature

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.update(
            tenant_id="tenantId",
            features=[
                TenantFeature(
                    id="id",
                )
            ],
        )
        """
        _response = self._raw_client.update(tenant_id, features=features, request_options=request_options)
        return _response.data

    def resume(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
        """
        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.resume(
            tenant_id="tenantId",
        )
        """
        _response = self._raw_client.resume(tenant_id, request_options=request_options)
        return _response.data

    def suspend(
        self,
        tenant_id: str,
        *,
        reason: typing.Optional[str] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> None:
        """
        Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.

        Parameters
        ----------
        tenant_id : str

        reason : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.suspend(
            tenant_id="tenantId",
        )
        """
        _response = self._raw_client.suspend(tenant_id, reason=reason, request_options=request_options)
        return _response.data

    def usage(
        self,
        tenant_id: str,
        *,
        period: typing.Optional[str] = None,
        from_: typing.Optional[str] = None,
        to: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsUsage200Response:
        """
        Facts only — no limits or billing state. Views count grant exchanges plus authorized /v1/access requests, deduplicated across the two.

        Parameters
        ----------
        tenant_id : str

        period : typing.Optional[str]

        from_ : typing.Optional[str]

        to : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsUsage200Response
            OK

        Examples
        --------
        from cloudpdf import CloudPDFClient

        client = CloudPDFClient(
            token="YOUR_TOKEN",
        )
        client.tenants.usage(
            tenant_id="tenantId",
        )
        """
        _response = self._raw_client.usage(
            tenant_id, period=period, from_=from_, to=to, request_options=request_options
        )
        return _response.data


class AsyncTenantsClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawTenantsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> AsyncRawTenantsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        AsyncRawTenantsClient
        """
        return self._raw_client

    async def list(
        self,
        *,
        limit: typing.Optional[int] = None,
        cursor: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsList200Response:
        """
        Parameters
        ----------
        limit : typing.Optional[int]

        cursor : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsList200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.list()


        asyncio.run(main())
        """
        _response = await self._raw_client.list(limit=limit, cursor=cursor, request_options=request_options)
        return _response.data

    async def create(
        self, *, id: str, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
    ) -> TenantsCreate200Response:
        """
        Parameters
        ----------
        id : str

        name : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsCreate200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.create(
                id="id",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.create(id=id, name=name, request_options=request_options)
        return _response.data

    async def get(
        self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None
    ) -> TenantsGet200Response:
        """
        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsGet200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.get(
                tenant_id="tenantId",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.get(tenant_id, request_options=request_options)
        return _response.data

    async def delete(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
        """
        Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.

        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.delete(
                tenant_id="tenantId",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.delete(tenant_id, request_options=request_options)
        return _response.data

    async def update(
        self,
        tenant_id: str,
        *,
        features: typing.Sequence[TenantFeature],
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsUpdate200Response:
        """
        A feature names an installed module; any other id is a 400. A module route answers a tenant without its feature 403 FeatureNotEnabled, and one whose feature is stopped 402 FeatureStopped (details.feature, details.stopped). Other replicas apply a change within 30 seconds.

        Parameters
        ----------
        tenant_id : str

        features : typing.Sequence[TenantFeature]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsUpdate200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient, TenantFeature

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.update(
                tenant_id="tenantId",
                features=[
                    TenantFeature(
                        id="id",
                    )
                ],
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.update(tenant_id, features=features, request_options=request_options)
        return _response.data

    async def resume(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
        """
        Parameters
        ----------
        tenant_id : str

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.resume(
                tenant_id="tenantId",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.resume(tenant_id, request_options=request_options)
        return _response.data

    async def suspend(
        self,
        tenant_id: str,
        *,
        reason: typing.Optional[str] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> None:
        """
        Instantly reversible with resume. The API token is exempt, so a suspended tenant can still be inspected, exported, resumed, or deleted.

        Parameters
        ----------
        tenant_id : str

        reason : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        None

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.suspend(
                tenant_id="tenantId",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.suspend(tenant_id, reason=reason, request_options=request_options)
        return _response.data

    async def usage(
        self,
        tenant_id: str,
        *,
        period: typing.Optional[str] = None,
        from_: typing.Optional[str] = None,
        to: typing.Optional[str] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> TenantsUsage200Response:
        """
        Facts only — no limits or billing state. Views count grant exchanges plus authorized /v1/access requests, deduplicated across the two.

        Parameters
        ----------
        tenant_id : str

        period : typing.Optional[str]

        from_ : typing.Optional[str]

        to : typing.Optional[str]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        TenantsUsage200Response
            OK

        Examples
        --------
        import asyncio

        from cloudpdf import AsyncCloudPDFClient

        client = AsyncCloudPDFClient(
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.tenants.usage(
                tenant_id="tenantId",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.usage(
            tenant_id, period=period, from_=from_, to=to, request_options=request_options
        )
        return _response.data