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

paid/customers/types/customers_check_entitlement_response.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CustomersCheckEntitlementResponse(UniversalBaseModel):
+    entitled: bool = pydantic.Field()
+    """
+    Whether the customer is entitled to the specified event
+    """
+
+    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/orders/client.py

@@ -1,11 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
+from ..types.cancel_renewal_response import CancelRenewalResponse
+from ..types.invoice import Invoice
 from ..types.order import Order
 from ..types.order_line_create import OrderLineCreate
+from ..types.proration_attribute_update import ProrationAttributeUpdate
+from ..types.proration_upgrade_response import ProrationUpgradeResponse
 from .lines.client import AsyncLinesClient, LinesClient
 from .raw_client import AsyncRawOrdersClient, RawOrdersClient
 
@@ -64,6 +69,7 @@ class OrdersClient:
         billing_contact_id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
         end_date: typing.Optional[str] = OMIT,
+        plan_id: typing.Optional[str] = OMIT,
         order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
@@ -86,6 +92,9 @@ class OrdersClient:
 
         end_date : typing.Optional[str]
 
+        plan_id : typing.Optional[str]
+            Optional plan ID to associate with this order
+
         order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
 
         request_options : typing.Optional[RequestOptions]
@@ -121,6 +130,7 @@ class OrdersClient:
             billing_contact_id=billing_contact_id,
             description=description,
             end_date=end_date,
+            plan_id=plan_id,
             order_lines=order_lines,
             request_options=request_options,
         )
@@ -209,6 +219,206 @@ class OrdersClient:
         _response = self._raw_client.activate(order_id, request_options=request_options)
         return _response.data
 
+    def activate_and_pay(
+        self,
+        order_id: str,
+        *,
+        confirmation_token: str,
+        return_url: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Order:
+        """
+        Activates the order and processes the initial payment using the provided Stripe confirmation token.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        confirmation_token : str
+            Stripe confirmation token for the payment method
+
+        return_url : str
+            URL to redirect to after payment processing
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Order
+            Order activated and payment processed successfully
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.orders.activate_and_pay(
+            order_id="orderId",
+            confirmation_token="ctoken_1234567890",
+            return_url="https://example.com/payment-complete",
+        )
+        """
+        _response = self._raw_client.activate_and_pay(
+            order_id, confirmation_token=confirmation_token, return_url=return_url, request_options=request_options
+        )
+        return _response.data
+
+    def cancel_renewal(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        cancel_from_date: dt.datetime,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CancelRenewalResponse:
+        """
+        Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        cancel_from_date : dt.datetime
+            The date from which the renewal should be cancelled (ISO 8601 format)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelRenewalResponse
+            Order renewal cancelled successfully
+
+        Examples
+        --------
+        import datetime
+
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.orders.cancel_renewal(
+            order_id="orderId",
+            order_version=1,
+            cancel_from_date=datetime.datetime.fromisoformat(
+                "2025-12-31 00:00:00+00:00",
+            ),
+        )
+        """
+        _response = self._raw_client.cancel_renewal(
+            order_id, order_version=order_version, cancel_from_date=cancel_from_date, request_options=request_options
+        )
+        return _response.data
+
+    def schedule_plan_change(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        effective_date: dt.datetime,
+        updated_order_line_attributes: typing.Sequence[ProrationAttributeUpdate],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProrationUpgradeResponse:
+        """
+        Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        effective_date : dt.datetime
+            The date when the plan change should take effect (ISO 8601 format)
+
+        updated_order_line_attributes : typing.Sequence[ProrationAttributeUpdate]
+            The list of order line attributes to update
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProrationUpgradeResponse
+            Plan change scheduled successfully
+
+        Examples
+        --------
+        import datetime
+
+        from paid import Paid, ProrationAttributeUpdate
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.orders.schedule_plan_change(
+            order_id="orderId",
+            order_version=1,
+            effective_date=datetime.datetime.fromisoformat(
+                "2025-02-01 00:00:00+00:00",
+            ),
+            updated_order_line_attributes=[
+                ProrationAttributeUpdate(
+                    order_line_attribute_id="a1b2c3d4-5678-90ab-cdef-1234567890ab",
+                    new_pricing={"unitPrice": 200, "currency": "USD"},
+                    new_quantity=10.0,
+                )
+            ],
+        )
+        """
+        _response = self._raw_client.schedule_plan_change(
+            order_id,
+            order_version=order_version,
+            effective_date=effective_date,
+            updated_order_line_attributes=updated_order_line_attributes,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_invoices(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[Invoice]:
+        """
+        Retrieves all invoices associated with a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Invoice]
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.orders.get_invoices(
+            order_id="orderId",
+        )
+        """
+        _response = self._raw_client.get_invoices(order_id, request_options=request_options)
+        return _response.data
+
 
 class AsyncOrdersClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -269,6 +479,7 @@ class AsyncOrdersClient:
         billing_contact_id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
         end_date: typing.Optional[str] = OMIT,
+        plan_id: typing.Optional[str] = OMIT,
         order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
@@ -291,6 +502,9 @@ class AsyncOrdersClient:
 
         end_date : typing.Optional[str]
 
+        plan_id : typing.Optional[str]
+            Optional plan ID to associate with this order
+
         order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
 
         request_options : typing.Optional[RequestOptions]
@@ -334,6 +548,7 @@ class AsyncOrdersClient:
             billing_contact_id=billing_contact_id,
             description=description,
             end_date=end_date,
+            plan_id=plan_id,
             order_lines=order_lines,
             request_options=request_options,
         )
@@ -445,3 +660,233 @@ class AsyncOrdersClient:
         """
         _response = await self._raw_client.activate(order_id, request_options=request_options)
         return _response.data
+
+    async def activate_and_pay(
+        self,
+        order_id: str,
+        *,
+        confirmation_token: str,
+        return_url: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Order:
+        """
+        Activates the order and processes the initial payment using the provided Stripe confirmation token.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        confirmation_token : str
+            Stripe confirmation token for the payment method
+
+        return_url : str
+            URL to redirect to after payment processing
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Order
+            Order activated and payment processed successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.activate_and_pay(
+                order_id="orderId",
+                confirmation_token="ctoken_1234567890",
+                return_url="https://example.com/payment-complete",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.activate_and_pay(
+            order_id, confirmation_token=confirmation_token, return_url=return_url, request_options=request_options
+        )
+        return _response.data
+
+    async def cancel_renewal(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        cancel_from_date: dt.datetime,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CancelRenewalResponse:
+        """
+        Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        cancel_from_date : dt.datetime
+            The date from which the renewal should be cancelled (ISO 8601 format)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelRenewalResponse
+            Order renewal cancelled successfully
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.cancel_renewal(
+                order_id="orderId",
+                order_version=1,
+                cancel_from_date=datetime.datetime.fromisoformat(
+                    "2025-12-31 00:00:00+00:00",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_renewal(
+            order_id, order_version=order_version, cancel_from_date=cancel_from_date, request_options=request_options
+        )
+        return _response.data
+
+    async def schedule_plan_change(
+        self,
+        order_id: str,
+        *,
+        order_version: int,
+        effective_date: dt.datetime,
+        updated_order_line_attributes: typing.Sequence[ProrationAttributeUpdate],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ProrationUpgradeResponse:
+        """
+        Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        order_version : int
+            The current version of the order (for optimistic locking)
+
+        effective_date : dt.datetime
+            The date when the plan change should take effect (ISO 8601 format)
+
+        updated_order_line_attributes : typing.Sequence[ProrationAttributeUpdate]
+            The list of order line attributes to update
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProrationUpgradeResponse
+            Plan change scheduled successfully
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from paid import AsyncPaid, ProrationAttributeUpdate
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.schedule_plan_change(
+                order_id="orderId",
+                order_version=1,
+                effective_date=datetime.datetime.fromisoformat(
+                    "2025-02-01 00:00:00+00:00",
+                ),
+                updated_order_line_attributes=[
+                    ProrationAttributeUpdate(
+                        order_line_attribute_id="a1b2c3d4-5678-90ab-cdef-1234567890ab",
+                        new_pricing={"unitPrice": 200, "currency": "USD"},
+                        new_quantity=10.0,
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.schedule_plan_change(
+            order_id,
+            order_version=order_version,
+            effective_date=effective_date,
+            updated_order_line_attributes=updated_order_line_attributes,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_invoices(
+        self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[Invoice]:
+        """
+        Retrieves all invoices associated with a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The order ID (can be internal ID or display ID)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Invoice]
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.get_invoices(
+                order_id="orderId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_invoices(order_id, request_options=request_options)
+        return _response.data