billkit-sdk 0.0.6__py3-none-any.whl

billkit/__init__.py

@@ -0,0 +1,329 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        AddonDefinition,
+        AddonType,
+        ApplyContractResponse,
+        AttachAddonResponse,
+        AttributeDataType,
+        BatchRegisterResponse,
+        BatchSubjectResult,
+        BillingConfig,
+        BillingCycle,
+        Cadence,
+        ChangePlanResponse,
+        ContractDefinition,
+        CreateAssignmentResponse,
+        CreateKeyResponse,
+        CreatePortalTokenResponse,
+        Decision,
+        FeatureDefinition,
+        FeatureType,
+        FeatureUsage,
+        FeatureValue,
+        GateResponse,
+        InvoiceFailureItem,
+        InvoiceLineItemResponse,
+        InvoiceListItem,
+        InvoicePreviewResponse,
+        KeyListItem,
+        Limit,
+        LimitDefinition,
+        LimitOne,
+        ListInvoiceFailuresParams,
+        ListInvoiceFailuresResponse,
+        ListInvoicesParams,
+        ListInvoicesResponse,
+        ListKeysResponse,
+        ListPlatformInvoicesResponse,
+        MonthlyRevenue,
+        OverageInfo,
+        OveragePolicy,
+        PaginationQuery,
+        PlanDefinition,
+        PlatformInvoiceItem,
+        PortalListInvoicesResponse,
+        PreviewOverageItem,
+        PricingBilling,
+        PricingFeature,
+        PricingMetadata,
+        PricingPlan,
+        PricingResponse,
+        RateCardDimension,
+        RateCardResponse,
+        RegisterSubjectRequest,
+        RegisterSubjectResponse,
+        RevenueResponse,
+        RevokeKeyResponse,
+        RotateKeyResponse,
+        SchemaDocument,
+        SchemaFormat,
+        SetUsageRejection,
+        SetUsageResponse,
+        SubjectDetailResponse,
+        SubjectInfo,
+        SubjectsResponse,
+        TenantMeResponse,
+        UsageResponse,
+        ValidationError,
+        ValidationErrorResponse,
+        ValidationWarning,
+    )
+    from .errors import (
+        BadGatewayError,
+        BadRequestError,
+        ConflictError,
+        ForbiddenError,
+        InternalServerError,
+        NotFoundError,
+        PaymentRequiredError,
+        ServiceUnavailableError,
+        TooManyRequestsError,
+        UnauthorizedError,
+        UnprocessableEntityError,
+    )
+    from . import (
+        addons,
+        api_keys,
+        assignments,
+        billing,
+        contracts,
+        entitlements,
+        invoices,
+        pricing,
+        schema,
+        subjects,
+        tenants,
+        usage,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncBillkitApi, BillkitApi
+    from .schema import GetSchemaRequestFormat, ValidateSchemaRequestFormat
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AddonDefinition": ".types",
+    "AddonType": ".types",
+    "ApplyContractResponse": ".types",
+    "AsyncBillkitApi": ".client",
+    "AttachAddonResponse": ".types",
+    "AttributeDataType": ".types",
+    "BadGatewayError": ".errors",
+    "BadRequestError": ".errors",
+    "BatchRegisterResponse": ".types",
+    "BatchSubjectResult": ".types",
+    "BillingConfig": ".types",
+    "BillingCycle": ".types",
+    "BillkitApi": ".client",
+    "Cadence": ".types",
+    "ChangePlanResponse": ".types",
+    "ConflictError": ".errors",
+    "ContractDefinition": ".types",
+    "CreateAssignmentResponse": ".types",
+    "CreateKeyResponse": ".types",
+    "CreatePortalTokenResponse": ".types",
+    "Decision": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "FeatureDefinition": ".types",
+    "FeatureType": ".types",
+    "FeatureUsage": ".types",
+    "FeatureValue": ".types",
+    "ForbiddenError": ".errors",
+    "GateResponse": ".types",
+    "GetSchemaRequestFormat": ".schema",
+    "InternalServerError": ".errors",
+    "InvoiceFailureItem": ".types",
+    "InvoiceLineItemResponse": ".types",
+    "InvoiceListItem": ".types",
+    "InvoicePreviewResponse": ".types",
+    "KeyListItem": ".types",
+    "Limit": ".types",
+    "LimitDefinition": ".types",
+    "LimitOne": ".types",
+    "ListInvoiceFailuresParams": ".types",
+    "ListInvoiceFailuresResponse": ".types",
+    "ListInvoicesParams": ".types",
+    "ListInvoicesResponse": ".types",
+    "ListKeysResponse": ".types",
+    "ListPlatformInvoicesResponse": ".types",
+    "MonthlyRevenue": ".types",
+    "NotFoundError": ".errors",
+    "OverageInfo": ".types",
+    "OveragePolicy": ".types",
+    "PaginationQuery": ".types",
+    "PaymentRequiredError": ".errors",
+    "PlanDefinition": ".types",
+    "PlatformInvoiceItem": ".types",
+    "PortalListInvoicesResponse": ".types",
+    "PreviewOverageItem": ".types",
+    "PricingBilling": ".types",
+    "PricingFeature": ".types",
+    "PricingMetadata": ".types",
+    "PricingPlan": ".types",
+    "PricingResponse": ".types",
+    "RateCardDimension": ".types",
+    "RateCardResponse": ".types",
+    "RegisterSubjectRequest": ".types",
+    "RegisterSubjectResponse": ".types",
+    "RevenueResponse": ".types",
+    "RevokeKeyResponse": ".types",
+    "RotateKeyResponse": ".types",
+    "SchemaDocument": ".types",
+    "SchemaFormat": ".types",
+    "ServiceUnavailableError": ".errors",
+    "SetUsageRejection": ".types",
+    "SetUsageResponse": ".types",
+    "SubjectDetailResponse": ".types",
+    "SubjectInfo": ".types",
+    "SubjectsResponse": ".types",
+    "TenantMeResponse": ".types",
+    "TooManyRequestsError": ".errors",
+    "UnauthorizedError": ".errors",
+    "UnprocessableEntityError": ".errors",
+    "UsageResponse": ".types",
+    "ValidateSchemaRequestFormat": ".schema",
+    "ValidationError": ".types",
+    "ValidationErrorResponse": ".types",
+    "ValidationWarning": ".types",
+    "__version__": ".version",
+    "addons": ".addons",
+    "api_keys": ".api_keys",
+    "assignments": ".assignments",
+    "billing": ".billing",
+    "contracts": ".contracts",
+    "entitlements": ".entitlements",
+    "invoices": ".invoices",
+    "pricing": ".pricing",
+    "schema": ".schema",
+    "subjects": ".subjects",
+    "tenants": ".tenants",
+    "usage": ".usage",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AddonDefinition",
+    "AddonType",
+    "ApplyContractResponse",
+    "AsyncBillkitApi",
+    "AttachAddonResponse",
+    "AttributeDataType",
+    "BadGatewayError",
+    "BadRequestError",
+    "BatchRegisterResponse",
+    "BatchSubjectResult",
+    "BillingConfig",
+    "BillingCycle",
+    "BillkitApi",
+    "Cadence",
+    "ChangePlanResponse",
+    "ConflictError",
+    "ContractDefinition",
+    "CreateAssignmentResponse",
+    "CreateKeyResponse",
+    "CreatePortalTokenResponse",
+    "Decision",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "FeatureDefinition",
+    "FeatureType",
+    "FeatureUsage",
+    "FeatureValue",
+    "ForbiddenError",
+    "GateResponse",
+    "GetSchemaRequestFormat",
+    "InternalServerError",
+    "InvoiceFailureItem",
+    "InvoiceLineItemResponse",
+    "InvoiceListItem",
+    "InvoicePreviewResponse",
+    "KeyListItem",
+    "Limit",
+    "LimitDefinition",
+    "LimitOne",
+    "ListInvoiceFailuresParams",
+    "ListInvoiceFailuresResponse",
+    "ListInvoicesParams",
+    "ListInvoicesResponse",
+    "ListKeysResponse",
+    "ListPlatformInvoicesResponse",
+    "MonthlyRevenue",
+    "NotFoundError",
+    "OverageInfo",
+    "OveragePolicy",
+    "PaginationQuery",
+    "PaymentRequiredError",
+    "PlanDefinition",
+    "PlatformInvoiceItem",
+    "PortalListInvoicesResponse",
+    "PreviewOverageItem",
+    "PricingBilling",
+    "PricingFeature",
+    "PricingMetadata",
+    "PricingPlan",
+    "PricingResponse",
+    "RateCardDimension",
+    "RateCardResponse",
+    "RegisterSubjectRequest",
+    "RegisterSubjectResponse",
+    "RevenueResponse",
+    "RevokeKeyResponse",
+    "RotateKeyResponse",
+    "SchemaDocument",
+    "SchemaFormat",
+    "ServiceUnavailableError",
+    "SetUsageRejection",
+    "SetUsageResponse",
+    "SubjectDetailResponse",
+    "SubjectInfo",
+    "SubjectsResponse",
+    "TenantMeResponse",
+    "TooManyRequestsError",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "UsageResponse",
+    "ValidateSchemaRequestFormat",
+    "ValidationError",
+    "ValidationErrorResponse",
+    "ValidationWarning",
+    "__version__",
+    "addons",
+    "api_keys",
+    "assignments",
+    "billing",
+    "contracts",
+    "entitlements",
+    "invoices",
+    "pricing",
+    "schema",
+    "subjects",
+    "tenants",
+    "usage",
+]

billkit/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install billkit-sdk[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

billkit/addons/__init__.py

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

billkit/addons/client.py

@@ -0,0 +1,245 @@
+# 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.attach_addon_response import AttachAddonResponse
+from .raw_client import AsyncRawAddonsClient, RawAddonsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AddonsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAddonsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAddonsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAddonsClient
+        """
+        return self._raw_client
+
+    def attach_addon(
+        self, *, addon_key: str, subject_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AttachAddonResponse:
+        """
+        Validates that the add-on key exists in the tenant's schema, attaches it to
+        the subject's existing assignment in the store, and invalidates the subject's
+        cache entries.
+
+        - If the request body is missing or malformed: returns 400 (via Axum rejection).
+        - If subject_id or addon_key is empty: returns 400.
+        - If the tenant has no schema uploaded: returns 422.
+        - If the add-on key does not exist in the schema: returns 422.
+        - If the subject has no existing assignment: returns 404.
+        - If a store or cache error occurs: returns 500.
+        - On success: returns 200 with the updated add-on list.
+
+        Parameters
+        ----------
+        addon_key : str
+
+        subject_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AttachAddonResponse
+            Add-on attached
+
+        Examples
+        --------
+        from billkit import BillkitApi
+
+        client = BillkitApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.addons.attach_addon(
+            addon_key="addon_key",
+            subject_id="subject_id",
+        )
+        """
+        _response = self._raw_client.attach_addon(
+            addon_key=addon_key, subject_id=subject_id, request_options=request_options
+        )
+        return _response.data
+
+    def detach_addon(
+        self, subject_id: str, addon_key: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Removes the given add-on from the subject's existing assignment in the store
+        and invalidates the subject's cache entries. Tenant is resolved from
+        `X-Api-Key` via the auth middleware.
+
+        - If subject_id or addon_key is empty: returns 400.
+        - If the subject has no existing assignment: returns 404.
+        - If a store error occurs: returns 500.
+        - On success: returns 204 No Content, whether or not the add-on was
+          actually attached (idempotent, matching `DELETE /assignments/{subject_id}`).
+
+        Parameters
+        ----------
+        subject_id : str
+            The subject identifier
+
+        addon_key : str
+            The add-on key to detach
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from billkit import BillkitApi
+
+        client = BillkitApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.addons.detach_addon(
+            subject_id="subject_id",
+            addon_key="addon_key",
+        )
+        """
+        _response = self._raw_client.detach_addon(subject_id, addon_key, request_options=request_options)
+        return _response.data
+
+
+class AsyncAddonsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAddonsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAddonsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAddonsClient
+        """
+        return self._raw_client
+
+    async def attach_addon(
+        self, *, addon_key: str, subject_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AttachAddonResponse:
+        """
+        Validates that the add-on key exists in the tenant's schema, attaches it to
+        the subject's existing assignment in the store, and invalidates the subject's
+        cache entries.
+
+        - If the request body is missing or malformed: returns 400 (via Axum rejection).
+        - If subject_id or addon_key is empty: returns 400.
+        - If the tenant has no schema uploaded: returns 422.
+        - If the add-on key does not exist in the schema: returns 422.
+        - If the subject has no existing assignment: returns 404.
+        - If a store or cache error occurs: returns 500.
+        - On success: returns 200 with the updated add-on list.
+
+        Parameters
+        ----------
+        addon_key : str
+
+        subject_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AttachAddonResponse
+            Add-on attached
+
+        Examples
+        --------
+        import asyncio
+
+        from billkit import AsyncBillkitApi
+
+        client = AsyncBillkitApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.addons.attach_addon(
+                addon_key="addon_key",
+                subject_id="subject_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.attach_addon(
+            addon_key=addon_key, subject_id=subject_id, request_options=request_options
+        )
+        return _response.data
+
+    async def detach_addon(
+        self, subject_id: str, addon_key: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Removes the given add-on from the subject's existing assignment in the store
+        and invalidates the subject's cache entries. Tenant is resolved from
+        `X-Api-Key` via the auth middleware.
+
+        - If subject_id or addon_key is empty: returns 400.
+        - If the subject has no existing assignment: returns 404.
+        - If a store error occurs: returns 500.
+        - On success: returns 204 No Content, whether or not the add-on was
+          actually attached (idempotent, matching `DELETE /assignments/{subject_id}`).
+
+        Parameters
+        ----------
+        subject_id : str
+            The subject identifier
+
+        addon_key : str
+            The add-on key to detach
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from billkit import AsyncBillkitApi
+
+        client = AsyncBillkitApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.addons.detach_addon(
+                subject_id="subject_id",
+                addon_key="addon_key",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.detach_addon(subject_id, addon_key, request_options=request_options)
+        return _response.data