paid-python 0.4.1a0__py3-none-any.whl → 0.5.0__py3-none-any.whl

paid/types/usage_summary.py

@@ -0,0 +1,121 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .usage_summary_order import UsageSummaryOrder
+from .usage_summary_order_line import UsageSummaryOrderLine
+
+
+class UsageSummary(UniversalBaseModel):
+    """
+    A single usage summary record
+    """
+
+    id: str = pydantic.Field()
+    """
+    The unique identifier of the usage summary
+    """
+
+    event_name: typing_extensions.Annotated[str, FieldMetadata(alias="eventName")] = pydantic.Field()
+    """
+    The name of the event being tracked
+    """
+
+    events_quantity: typing_extensions.Annotated[int, FieldMetadata(alias="eventsQuantity")] = pydantic.Field()
+    """
+    The quantity of events in this usage period
+    """
+
+    start_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="startDate")] = pydantic.Field()
+    """
+    The start date of the usage period
+    """
+
+    end_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="endDate")] = pydantic.Field()
+    """
+    The end date of the usage period
+    """
+
+    subtotal: int = pydantic.Field()
+    """
+    The subtotal amount in the smallest currency unit (e.g., cents)
+    """
+
+    next_billing_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="nextBillingDate")] = (
+        pydantic.Field()
+    )
+    """
+    The next billing date for this usage
+    """
+
+    customer_id: typing_extensions.Annotated[str, FieldMetadata(alias="customerId")] = pydantic.Field()
+    """
+    The internal customer ID
+    """
+
+    order_id: typing_extensions.Annotated[str, FieldMetadata(alias="orderId")] = pydantic.Field()
+    """
+    The order ID associated with this usage
+    """
+
+    order_line_id: typing_extensions.Annotated[str, FieldMetadata(alias="orderLineId")] = pydantic.Field()
+    """
+    The order line ID associated with this usage
+    """
+
+    order_line_attribute_id: typing_extensions.Annotated[str, FieldMetadata(alias="orderLineAttributeId")] = (
+        pydantic.Field()
+    )
+    """
+    The order line attribute ID associated with this usage
+    """
+
+    invoice_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="invoiceId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The invoice ID if this usage has been invoiced
+    """
+
+    invoice_line_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="invoiceLineId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The invoice line ID if this usage has been invoiced
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the usage summary was created
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the usage summary was last updated
+    """
+
+    order: typing.Optional[UsageSummaryOrder] = pydantic.Field(default=None)
+    """
+    Associated order information
+    """
+
+    order_line: typing_extensions.Annotated[
+        typing.Optional[UsageSummaryOrderLine], FieldMetadata(alias="orderLine")
+    ] = pydantic.Field(default=None)
+    """
+    Associated order line information
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

paid/types/usage_summary_order.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class UsageSummaryOrder(UniversalBaseModel):
+    """
+    Associated order information
+    """
+
+    id: typing.Optional[str] = None
+    display_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayId")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

paid/types/usage_summary_order_line.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class UsageSummaryOrderLine(UniversalBaseModel):
+    """
+    Associated order line information
+    """
+
+    id: typing.Optional[str] = None
+    display_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayId")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

paid/usage/__init__.py

@@ -2,3 +2,6 @@
 
 # isort: skip_file
 
+from .types import UsageCheckUsageResponse
+
+__all__ = ["UsageCheckUsageResponse"]

paid/usage/client.py

@@ -5,7 +5,9 @@ import typing
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.signal import Signal
+from ..types.signal_v_2 import SignalV2
 from .raw_client import AsyncRawUsageClient, RawUsageClient
+from .types.usage_check_usage_response import UsageCheckUsageResponse
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -33,6 +35,8 @@ class UsageClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+        DEPRECATED: Use POST /usage/v2/signals/bulk instead for cleaner field names.
+
         Parameters
         ----------
         signals : typing.Optional[typing.Sequence[Signal]]
@@ -58,6 +62,98 @@ class UsageClient:
         _response = self._raw_client.record_bulk(signals=signals, request_options=request_options)
         return _response.data
 
+    def usage_record_bulk_v_2(
+        self,
+        *,
+        signals: typing.Optional[typing.Sequence[SignalV2]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        signals : typing.Optional[typing.Sequence[SignalV2]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from paid import Paid, SignalV2
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.usage.usage_record_bulk_v_2(
+            signals=[
+                SignalV2(
+                    event_name="emails_sent",
+                    product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                    customer_id="7d0b6fce-d82a-433d-8315-c994f8f1d68d",
+                ),
+                SignalV2(
+                    event_name="emails_sent",
+                    external_product_id="acme-product",
+                    external_customer_id="acme-inc",
+                ),
+                SignalV2(
+                    event_name="meeting_booked",
+                    product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                    external_customer_id="acme-inc",
+                    data={"meeting_duration": 30, "meeting_type": "demo"},
+                ),
+            ],
+        )
+        """
+        _response = self._raw_client.usage_record_bulk_v_2(signals=signals, request_options=request_options)
+        return _response.data
+
+    def check_usage(
+        self,
+        *,
+        external_customer_id: str,
+        external_product_id: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UsageCheckUsageResponse:
+        """
+        Parameters
+        ----------
+        external_customer_id : str
+            External customer ID
+
+        external_product_id : str
+            External product ID (the external ID of the product/agent)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UsageCheckUsageResponse
+            Usage check response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.usage.check_usage(
+            external_customer_id="acme-inc",
+            external_product_id="acme-agent",
+        )
+        """
+        _response = self._raw_client.check_usage(
+            external_customer_id=external_customer_id,
+            external_product_id=external_product_id,
+            request_options=request_options,
+        )
+        return _response.data
+
 
 class AsyncUsageClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -81,6 +177,8 @@ class AsyncUsageClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+        DEPRECATED: Use POST /usage/v2/signals/bulk instead for cleaner field names.
+
         Parameters
         ----------
         signals : typing.Optional[typing.Sequence[Signal]]
@@ -113,3 +211,111 @@ class AsyncUsageClient:
         """
         _response = await self._raw_client.record_bulk(signals=signals, request_options=request_options)
         return _response.data
+
+    async def usage_record_bulk_v_2(
+        self,
+        *,
+        signals: typing.Optional[typing.Sequence[SignalV2]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        signals : typing.Optional[typing.Sequence[SignalV2]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid, SignalV2
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.usage.usage_record_bulk_v_2(
+                signals=[
+                    SignalV2(
+                        event_name="emails_sent",
+                        product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                        customer_id="7d0b6fce-d82a-433d-8315-c994f8f1d68d",
+                    ),
+                    SignalV2(
+                        event_name="emails_sent",
+                        external_product_id="acme-product",
+                        external_customer_id="acme-inc",
+                    ),
+                    SignalV2(
+                        event_name="meeting_booked",
+                        product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                        external_customer_id="acme-inc",
+                        data={"meeting_duration": 30, "meeting_type": "demo"},
+                    ),
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.usage_record_bulk_v_2(signals=signals, request_options=request_options)
+        return _response.data
+
+    async def check_usage(
+        self,
+        *,
+        external_customer_id: str,
+        external_product_id: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UsageCheckUsageResponse:
+        """
+        Parameters
+        ----------
+        external_customer_id : str
+            External customer ID
+
+        external_product_id : str
+            External product ID (the external ID of the product/agent)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UsageCheckUsageResponse
+            Usage check response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.usage.check_usage(
+                external_customer_id="acme-inc",
+                external_product_id="acme-agent",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.check_usage(
+            external_customer_id=external_customer_id,
+            external_product_id=external_product_id,
+            request_options=request_options,
+        )
+        return _response.data