mirascope 2.0.0__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

mirascope/api/_generated/organizations/client.py

@@ -1,869 +0,0 @@
-# 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 .raw_client import AsyncRawOrganizationsClient, RawOrganizationsClient
-from .types.organizations_create_payment_intent_response import (
-    OrganizationsCreatePaymentIntentResponse,
-)
-from .types.organizations_create_response import OrganizationsCreateResponse
-from .types.organizations_get_response import OrganizationsGetResponse
-from .types.organizations_list_response_item import OrganizationsListResponseItem
-from .types.organizations_preview_subscription_change_request_target_plan import (
-    OrganizationsPreviewSubscriptionChangeRequestTargetPlan,
-)
-from .types.organizations_preview_subscription_change_response import (
-    OrganizationsPreviewSubscriptionChangeResponse,
-)
-from .types.organizations_router_balance_response import (
-    OrganizationsRouterBalanceResponse,
-)
-from .types.organizations_subscription_response import OrganizationsSubscriptionResponse
-from .types.organizations_update_response import OrganizationsUpdateResponse
-from .types.organizations_update_subscription_request_target_plan import (
-    OrganizationsUpdateSubscriptionRequestTargetPlan,
-)
-from .types.organizations_update_subscription_response import (
-    OrganizationsUpdateSubscriptionResponse,
-)
-
-# this is used as the default value for optional parameters
-OMIT = typing.cast(typing.Any, ...)
-
-
-class OrganizationsClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._raw_client = RawOrganizationsClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> RawOrganizationsClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        RawOrganizationsClient
-        """
-        return self._raw_client
-
-    def list(
-        self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[OrganizationsListResponseItem]:
-        """
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        typing.List[OrganizationsListResponseItem]
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.list()
-        """
-        _response = self._raw_client.list(request_options=request_options)
-        return _response.data
-
-    def create(
-        self,
-        *,
-        name: str,
-        slug: str,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsCreateResponse:
-        """
-        Parameters
-        ----------
-        name : str
-            a string at most 100 character(s) long
-
-        slug : str
-            a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsCreateResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.create(
-            name="name",
-            slug="slug",
-        )
-        """
-        _response = self._raw_client.create(
-            name=name, slug=slug, request_options=request_options
-        )
-        return _response.data
-
-    def get(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsGetResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsGetResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.get(
-            id="id",
-        )
-        """
-        _response = self._raw_client.get(id, request_options=request_options)
-        return _response.data
-
-    def update(
-        self,
-        id: str,
-        *,
-        name: typing.Optional[str] = OMIT,
-        slug: typing.Optional[str] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsUpdateResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        name : typing.Optional[str]
-            a string at most 100 character(s) long
-
-        slug : typing.Optional[str]
-            a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsUpdateResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.update(
-            id="id",
-        )
-        """
-        _response = self._raw_client.update(
-            id, name=name, slug=slug, request_options=request_options
-        )
-        return _response.data
-
-    def delete(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.delete(
-            id="id",
-        )
-        """
-        _response = self._raw_client.delete(id, request_options=request_options)
-        return _response.data
-
-    def routerbalance(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsRouterBalanceResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsRouterBalanceResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.routerbalance(
-            id="id",
-        )
-        """
-        _response = self._raw_client.routerbalance(id, request_options=request_options)
-        return _response.data
-
-    def createpaymentintent(
-        self,
-        id: str,
-        *,
-        amount: float,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsCreatePaymentIntentResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        amount : float
-            a positive number
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsCreatePaymentIntentResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.createpaymentintent(
-            id="id",
-            amount=1.1,
-        )
-        """
-        _response = self._raw_client.createpaymentintent(
-            id, amount=amount, request_options=request_options
-        )
-        return _response.data
-
-    def subscription(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsSubscriptionResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsSubscriptionResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.subscription(
-            id="id",
-        )
-        """
-        _response = self._raw_client.subscription(id, request_options=request_options)
-        return _response.data
-
-    def previewsubscriptionchange(
-        self,
-        id: str,
-        *,
-        target_plan: OrganizationsPreviewSubscriptionChangeRequestTargetPlan,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsPreviewSubscriptionChangeResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        target_plan : OrganizationsPreviewSubscriptionChangeRequestTargetPlan
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsPreviewSubscriptionChangeResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.previewsubscriptionchange(
-            id="id",
-            target_plan="free",
-        )
-        """
-        _response = self._raw_client.previewsubscriptionchange(
-            id, target_plan=target_plan, request_options=request_options
-        )
-        return _response.data
-
-    def updatesubscription(
-        self,
-        id: str,
-        *,
-        target_plan: OrganizationsUpdateSubscriptionRequestTargetPlan,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsUpdateSubscriptionResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        target_plan : OrganizationsUpdateSubscriptionRequestTargetPlan
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsUpdateSubscriptionResponse
-            Success
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.updatesubscription(
-            id="id",
-            target_plan="free",
-        )
-        """
-        _response = self._raw_client.updatesubscription(
-            id, target_plan=target_plan, request_options=request_options
-        )
-        return _response.data
-
-    def cancelscheduleddowngrade(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from mirascope.api._generated import Mirascope
-
-        client = Mirascope()
-        client.organizations.cancelscheduleddowngrade(
-            id="id",
-        )
-        """
-        _response = self._raw_client.cancelscheduleddowngrade(
-            id, request_options=request_options
-        )
-        return _response.data
-
-
-class AsyncOrganizationsClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._raw_client = AsyncRawOrganizationsClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> AsyncRawOrganizationsClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        AsyncRawOrganizationsClient
-        """
-        return self._raw_client
-
-    async def list(
-        self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[OrganizationsListResponseItem]:
-        """
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        typing.List[OrganizationsListResponseItem]
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.list()
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.list(request_options=request_options)
-        return _response.data
-
-    async def create(
-        self,
-        *,
-        name: str,
-        slug: str,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsCreateResponse:
-        """
-        Parameters
-        ----------
-        name : str
-            a string at most 100 character(s) long
-
-        slug : str
-            a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsCreateResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.create(
-                name="name",
-                slug="slug",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.create(
-            name=name, slug=slug, request_options=request_options
-        )
-        return _response.data
-
-    async def get(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsGetResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsGetResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.get(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.get(id, request_options=request_options)
-        return _response.data
-
-    async def update(
-        self,
-        id: str,
-        *,
-        name: typing.Optional[str] = OMIT,
-        slug: typing.Optional[str] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsUpdateResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        name : typing.Optional[str]
-            a string at most 100 character(s) long
-
-        slug : typing.Optional[str]
-            a string matching the pattern ^[a-z0-9][a-z0-9_-]*[a-z0-9]$
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsUpdateResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.update(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.update(
-            id, name=name, slug=slug, request_options=request_options
-        )
-        return _response.data
-
-    async def delete(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.delete(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.delete(id, request_options=request_options)
-        return _response.data
-
-    async def routerbalance(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsRouterBalanceResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsRouterBalanceResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.routerbalance(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.routerbalance(
-            id, request_options=request_options
-        )
-        return _response.data
-
-    async def createpaymentintent(
-        self,
-        id: str,
-        *,
-        amount: float,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsCreatePaymentIntentResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        amount : float
-            a positive number
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsCreatePaymentIntentResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.createpaymentintent(
-                id="id",
-                amount=1.1,
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.createpaymentintent(
-            id, amount=amount, request_options=request_options
-        )
-        return _response.data
-
-    async def subscription(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> OrganizationsSubscriptionResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsSubscriptionResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.subscription(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.subscription(
-            id, request_options=request_options
-        )
-        return _response.data
-
-    async def previewsubscriptionchange(
-        self,
-        id: str,
-        *,
-        target_plan: OrganizationsPreviewSubscriptionChangeRequestTargetPlan,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsPreviewSubscriptionChangeResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        target_plan : OrganizationsPreviewSubscriptionChangeRequestTargetPlan
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsPreviewSubscriptionChangeResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.previewsubscriptionchange(
-                id="id",
-                target_plan="free",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.previewsubscriptionchange(
-            id, target_plan=target_plan, request_options=request_options
-        )
-        return _response.data
-
-    async def updatesubscription(
-        self,
-        id: str,
-        *,
-        target_plan: OrganizationsUpdateSubscriptionRequestTargetPlan,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> OrganizationsUpdateSubscriptionResponse:
-        """
-        Parameters
-        ----------
-        id : str
-
-        target_plan : OrganizationsUpdateSubscriptionRequestTargetPlan
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        OrganizationsUpdateSubscriptionResponse
-            Success
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.updatesubscription(
-                id="id",
-                target_plan="free",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.updatesubscription(
-            id, target_plan=target_plan, request_options=request_options
-        )
-        return _response.data
-
-    async def cancelscheduleddowngrade(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Parameters
-        ----------
-        id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from mirascope.api._generated import AsyncMirascope
-
-        client = AsyncMirascope()
-
-
-        async def main() -> None:
-            await client.organizations.cancelscheduleddowngrade(
-                id="id",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.cancelscheduleddowngrade(
-            id, request_options=request_options
-        )
-        return _response.data