termina 0.0.0__py3-none-any.whl

termina/__init__.py

@@ -0,0 +1,184 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    AccountManagerResponse,
+    AllDataMetadataResponse,
+    Area,
+    AuthenticateApiKeyResponse,
+    AvailableCategoriesResponse,
+    AvailableModelsResponse,
+    BandResponse,
+    BenchmarkQuantile,
+    CategoriesMetadataResponse,
+    CategoryGrowthRates,
+    CategoryMetadata,
+    CategoryMetadataDefaultUserType,
+    CohortsResponse,
+    ColumnMetadata,
+    ColumnMiniMetadata,
+    ColumnsMetadataResponse,
+    CompanyResponse,
+    ConcentrationEndpointCdfDetail,
+    ConcentrationEndpointTopUsersDetail,
+    ConcentrationResponse,
+    ConcentrationTimeseriesDetail,
+    ContributionResponse,
+    CreateApiKeyResponse,
+    CreateFileResponse,
+    DealCombinedMetricsResponse,
+    DealDataAvailablityResponse,
+    DealWithFilesResponse,
+    FileResponse,
+    FileType,
+    FinancialMetrics,
+    FinancialsResponse,
+    Freq,
+    Frequency,
+    GcsSignedUrlResponse,
+    GroupResponse,
+    GroupUser,
+    GroupWithUsersResponse,
+    GrowthAccountingResponse,
+    HealthzResponse,
+    HttpValidationError,
+    IncomeStatementEntry,
+    ListCompaniesResponse,
+    ListDealsResponse,
+    ListFilesResponse,
+    ListUsersResponse,
+    ModelMetadata,
+    ModelsMetadataResponse,
+    PermissionModel,
+    Priority,
+    ProductInfoResponse,
+    RoleResponse,
+    Scale,
+    ScaleModel,
+    ScaleModelsResponse,
+    Scaling,
+    Status,
+    TradeoffModel,
+    TradeoffModelsResponse,
+    Unit,
+    UnitEconomicsInfoResponse,
+    UserAccountingResponse,
+    UserRoleResponse,
+    UserType,
+    UserWithPermissionsResponse,
+    ValidationError,
+    ValidationErrorLocItem,
+    WeatherComponents,
+    WeatherGauge,
+    WeatherMarketContext,
+    WeatherMetadata,
+    WeatherMetadataResponse,
+)
+from .errors import UnprocessableEntityError
+from . import auth, benchmark, company, deal, file, financials, group, macro, metadata, product, unit_economics, user
+from .benchmark import (
+    BenchmarkGetCombinedTimeSeriesRequestUserType,
+    BenchmarkGetDealBenchmarkQuantilesRequestUserType,
+    BenchmarkGetDealBenchmarkTradeoffAtScaleRequestUserType,
+    BenchmarkGetQuantilesRequestUserType,
+    BenchmarkGetScalingRequestUserType,
+    BenchmarkGetTimeSeriesEndpointRequestUserType,
+    BenchmarkGetTradeoffAtScaleRequestUserType,
+)
+from .environment import TerminaEnvironment
+from .version import __version__
+
+__all__ = [
+    "AccountManagerResponse",
+    "AllDataMetadataResponse",
+    "Area",
+    "AuthenticateApiKeyResponse",
+    "AvailableCategoriesResponse",
+    "AvailableModelsResponse",
+    "BandResponse",
+    "BenchmarkGetCombinedTimeSeriesRequestUserType",
+    "BenchmarkGetDealBenchmarkQuantilesRequestUserType",
+    "BenchmarkGetDealBenchmarkTradeoffAtScaleRequestUserType",
+    "BenchmarkGetQuantilesRequestUserType",
+    "BenchmarkGetScalingRequestUserType",
+    "BenchmarkGetTimeSeriesEndpointRequestUserType",
+    "BenchmarkGetTradeoffAtScaleRequestUserType",
+    "BenchmarkQuantile",
+    "CategoriesMetadataResponse",
+    "CategoryGrowthRates",
+    "CategoryMetadata",
+    "CategoryMetadataDefaultUserType",
+    "CohortsResponse",
+    "ColumnMetadata",
+    "ColumnMiniMetadata",
+    "ColumnsMetadataResponse",
+    "CompanyResponse",
+    "ConcentrationEndpointCdfDetail",
+    "ConcentrationEndpointTopUsersDetail",
+    "ConcentrationResponse",
+    "ConcentrationTimeseriesDetail",
+    "ContributionResponse",
+    "CreateApiKeyResponse",
+    "CreateFileResponse",
+    "DealCombinedMetricsResponse",
+    "DealDataAvailablityResponse",
+    "DealWithFilesResponse",
+    "FileResponse",
+    "FileType",
+    "FinancialMetrics",
+    "FinancialsResponse",
+    "Freq",
+    "Frequency",
+    "GcsSignedUrlResponse",
+    "GroupResponse",
+    "GroupUser",
+    "GroupWithUsersResponse",
+    "GrowthAccountingResponse",
+    "HealthzResponse",
+    "HttpValidationError",
+    "IncomeStatementEntry",
+    "ListCompaniesResponse",
+    "ListDealsResponse",
+    "ListFilesResponse",
+    "ListUsersResponse",
+    "ModelMetadata",
+    "ModelsMetadataResponse",
+    "PermissionModel",
+    "Priority",
+    "ProductInfoResponse",
+    "RoleResponse",
+    "Scale",
+    "ScaleModel",
+    "ScaleModelsResponse",
+    "Scaling",
+    "Status",
+    "TerminaEnvironment",
+    "TradeoffModel",
+    "TradeoffModelsResponse",
+    "Unit",
+    "UnitEconomicsInfoResponse",
+    "UnprocessableEntityError",
+    "UserAccountingResponse",
+    "UserRoleResponse",
+    "UserType",
+    "UserWithPermissionsResponse",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "WeatherComponents",
+    "WeatherGauge",
+    "WeatherMarketContext",
+    "WeatherMetadata",
+    "WeatherMetadataResponse",
+    "__version__",
+    "auth",
+    "benchmark",
+    "company",
+    "deal",
+    "file",
+    "financials",
+    "group",
+    "macro",
+    "metadata",
+    "product",
+    "unit_economics",
+    "user",
+]

termina/auth/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

termina/auth/client.py

@@ -0,0 +1,127 @@
+# 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.pydantic_utilities import pydantic_v1
+from ..core.request_options import RequestOptions
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.authenticate_api_key_response import AuthenticateApiKeyResponse
+from ..types.http_validation_error import HttpValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AuthClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_token(
+        self, *, api_key: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AuthenticateApiKeyResponse:
+        """
+        Authenticate an API key and return an access token
+
+        Returns a client JWT for the provided API key, where the JWT contains claims for permissions and access and can be
+        refreshed as part of an OAuth flow.
+
+        Parameters
+        ----------
+        api_key : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AuthenticateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        from termina.client import Termina
+
+        client = Termina(
+            token="YOUR_TOKEN",
+        )
+        client.auth.get_token(
+            api_key="api_key",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/v1/auth/get-token",
+            method="POST",
+            json={"api_key": api_key},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(AuthenticateApiKeyResponse, _response.json())  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(
+                pydantic_v1.parse_obj_as(HttpValidationError, _response.json())  # type: ignore
+            )
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncAuthClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_token(
+        self, *, api_key: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AuthenticateApiKeyResponse:
+        """
+        Authenticate an API key and return an access token
+
+        Returns a client JWT for the provided API key, where the JWT contains claims for permissions and access and can be
+        refreshed as part of an OAuth flow.
+
+        Parameters
+        ----------
+        api_key : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AuthenticateApiKeyResponse
+            Successful Response
+
+        Examples
+        --------
+        from termina.client import AsyncTermina
+
+        client = AsyncTermina(
+            token="YOUR_TOKEN",
+        )
+        await client.auth.get_token(
+            api_key="api_key",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/v1/auth/get-token",
+            method="POST",
+            json={"api_key": api_key},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(AuthenticateApiKeyResponse, _response.json())  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(
+                pydantic_v1.parse_obj_as(HttpValidationError, _response.json())  # type: ignore
+            )
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

termina/base_client.py

@@ -0,0 +1,242 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+import httpx
+
+from .auth.client import AsyncAuthClient, AuthClient
+from .benchmark.client import AsyncBenchmarkClient, BenchmarkClient
+from .company.client import AsyncCompanyClient, CompanyClient
+from .core.api_error import ApiError
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.pydantic_utilities import pydantic_v1
+from .core.request_options import RequestOptions
+from .deal.client import AsyncDealClient, DealClient
+from .environment import TerminaEnvironment
+from .file.client import AsyncFileClient, FileClient
+from .financials.client import AsyncFinancialsClient, FinancialsClient
+from .group.client import AsyncGroupClient, GroupClient
+from .macro.client import AsyncMacroClient, MacroClient
+from .metadata.client import AsyncMetadataClient, MetadataClient
+from .product.client import AsyncProductClient, ProductClient
+from .types.healthz_response import HealthzResponse
+from .unit_economics.client import AsyncUnitEconomicsClient, UnitEconomicsClient
+from .user.client import AsyncUserClient, UserClient
+
+
+class BaseClient:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : TerminaEnvironment
+        The environment to use for requests from the client. from .environment import TerminaEnvironment
+
+
+
+        Defaults to TerminaEnvironment.DEFAULT
+
+
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from termina.client import Termina
+
+    client = Termina(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: TerminaEnvironment = TerminaEnvironment.DEFAULT,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.auth = AuthClient(client_wrapper=self._client_wrapper)
+        self.group = GroupClient(client_wrapper=self._client_wrapper)
+        self.user = UserClient(client_wrapper=self._client_wrapper)
+        self.macro = MacroClient(client_wrapper=self._client_wrapper)
+        self.company = CompanyClient(client_wrapper=self._client_wrapper)
+        self.deal = DealClient(client_wrapper=self._client_wrapper)
+        self.file = FileClient(client_wrapper=self._client_wrapper)
+        self.financials = FinancialsClient(client_wrapper=self._client_wrapper)
+        self.product = ProductClient(client_wrapper=self._client_wrapper)
+        self.unit_economics = UnitEconomicsClient(client_wrapper=self._client_wrapper)
+        self.metadata = MetadataClient(client_wrapper=self._client_wrapper)
+        self.benchmark = BenchmarkClient(client_wrapper=self._client_wrapper)
+
+    def healthz(self, *, request_options: typing.Optional[RequestOptions] = None) -> HealthzResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HealthzResponse
+            Successful Response
+
+        Examples
+        --------
+        from termina.client import Termina
+
+        client = Termina(
+            token="YOUR_TOKEN",
+        )
+        client.healthz()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/v1/healthz", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(HealthzResponse, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncBaseClient:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : TerminaEnvironment
+        The environment to use for requests from the client. from .environment import TerminaEnvironment
+
+
+
+        Defaults to TerminaEnvironment.DEFAULT
+
+
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from termina.client import AsyncTermina
+
+    client = AsyncTermina(
+        token="YOUR_TOKEN",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: TerminaEnvironment = TerminaEnvironment.DEFAULT,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.auth = AsyncAuthClient(client_wrapper=self._client_wrapper)
+        self.group = AsyncGroupClient(client_wrapper=self._client_wrapper)
+        self.user = AsyncUserClient(client_wrapper=self._client_wrapper)
+        self.macro = AsyncMacroClient(client_wrapper=self._client_wrapper)
+        self.company = AsyncCompanyClient(client_wrapper=self._client_wrapper)
+        self.deal = AsyncDealClient(client_wrapper=self._client_wrapper)
+        self.file = AsyncFileClient(client_wrapper=self._client_wrapper)
+        self.financials = AsyncFinancialsClient(client_wrapper=self._client_wrapper)
+        self.product = AsyncProductClient(client_wrapper=self._client_wrapper)
+        self.unit_economics = AsyncUnitEconomicsClient(client_wrapper=self._client_wrapper)
+        self.metadata = AsyncMetadataClient(client_wrapper=self._client_wrapper)
+        self.benchmark = AsyncBenchmarkClient(client_wrapper=self._client_wrapper)
+
+    async def healthz(self, *, request_options: typing.Optional[RequestOptions] = None) -> HealthzResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HealthzResponse
+            Successful Response
+
+        Examples
+        --------
+        from termina.client import AsyncTermina
+
+        client = AsyncTermina(
+            token="YOUR_TOKEN",
+        )
+        await client.healthz()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/v1/healthz", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(HealthzResponse, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: TerminaEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

termina/benchmark/__init__.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    BenchmarkGetCombinedTimeSeriesRequestUserType,
+    BenchmarkGetDealBenchmarkQuantilesRequestUserType,
+    BenchmarkGetDealBenchmarkTradeoffAtScaleRequestUserType,
+    BenchmarkGetQuantilesRequestUserType,
+    BenchmarkGetScalingRequestUserType,
+    BenchmarkGetTimeSeriesEndpointRequestUserType,
+    BenchmarkGetTradeoffAtScaleRequestUserType,
+)
+
+__all__ = [
+    "BenchmarkGetCombinedTimeSeriesRequestUserType",
+    "BenchmarkGetDealBenchmarkQuantilesRequestUserType",
+    "BenchmarkGetDealBenchmarkTradeoffAtScaleRequestUserType",
+    "BenchmarkGetQuantilesRequestUserType",
+    "BenchmarkGetScalingRequestUserType",
+    "BenchmarkGetTimeSeriesEndpointRequestUserType",
+    "BenchmarkGetTradeoffAtScaleRequestUserType",
+]