paid-python 0.5.0__tar.gz → 0.6.0__tar.gz

{paid_python-0.5.0 → paid_python-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: paid-python
-Version: 0.5.0
+Version: 0.6.0
 Summary: 
 Requires-Python: >=3.9,<3.14
 Classifier: Intended Audience :: Developers

{paid_python-0.5.0 → paid_python-0.6.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "paid-python"
 
 [tool.poetry]
 name = "paid-python"
-version = "0.5.0"
+version = "0.6.0"
 description = ""
 readme = "README.md"
 authors = []

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/__init__.py

@@ -30,6 +30,7 @@ from .types import (
     OrderLineCreate,
     PaginationMeta,
     Plan,
+    PlanGroup,
     PlanPlanProductsItem,
     PlanPlanProductsItemPlanProductAttributeItem,
     PricePoint,
@@ -95,6 +96,7 @@ __all__ = [
     "Paid",
     "PaidEnvironment",
     "Plan",
+    "PlanGroup",
     "PlanPlanProductsItem",
     "PlanPlanProductsItemPlanProductAttributeItem",
     "PricePoint",

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/core/client_wrapper.py

@@ -22,7 +22,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "paid",
-            "X-Fern-SDK-Version": "0.5.0",
+            "X-Fern-SDK-Version": "0.6.0",
         }
         token = self._get_token()
         if token is not None:

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/orders/client.py

@@ -64,6 +64,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 +87,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 +125,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,
         )
@@ -269,6 +274,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 +297,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 +343,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,
         )

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/orders/raw_client.py

@@ -64,6 +64,7 @@ class RawOrdersClient:
         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,
     ) -> HttpResponse[Order]:
@@ -86,6 +87,9 @@ class RawOrdersClient:
 
         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]
@@ -108,6 +112,7 @@ class RawOrdersClient:
                 "startDate": start_date,
                 "endDate": end_date,
                 "currency": currency,
+                "planId": plan_id,
                 "orderLines": convert_and_respect_annotation_metadata(
                     object_=order_lines, annotation=typing.Sequence[OrderLineCreate], direction="write"
                 ),
@@ -279,6 +284,7 @@ class AsyncRawOrdersClient:
         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,
     ) -> AsyncHttpResponse[Order]:
@@ -301,6 +307,9 @@ class AsyncRawOrdersClient:
 
         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]
@@ -323,6 +332,7 @@ class AsyncRawOrdersClient:
                 "startDate": start_date,
                 "endDate": end_date,
                 "currency": currency,
+                "planId": plan_id,
                 "orderLines": convert_and_respect_annotation_metadata(
                     object_=order_lines, annotation=typing.Sequence[OrderLineCreate], direction="write"
                 ),

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/plans/client.py

@@ -6,6 +6,7 @@ import typing
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.plan import Plan
+from ..types.plan_group import PlanGroup
 from ..types.usage_summaries_response import UsageSummariesResponse
 from .raw_client import AsyncRawPlansClient, RawPlansClient
 
@@ -127,6 +128,37 @@ class PlansClient:
         )
         return _response.data
 
+    def get_group_by_id(
+        self, plan_group_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PlanGroup:
+        """
+        Parameters
+        ----------
+        plan_group_id : str
+            The ID of the plan group
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PlanGroup
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.plans.get_group_by_id(
+            plan_group_id="planGroupId",
+        )
+        """
+        _response = self._raw_client.get_group_by_id(plan_group_id, request_options=request_options)
+        return _response.data
+
 
 class AsyncPlansClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -259,3 +291,42 @@ class AsyncPlansClient:
             request_options=request_options,
         )
         return _response.data
+
+    async def get_group_by_id(
+        self, plan_group_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PlanGroup:
+        """
+        Parameters
+        ----------
+        plan_group_id : str
+            The ID of the plan group
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PlanGroup
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.plans.get_group_by_id(
+                plan_group_id="planGroupId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_group_by_id(plan_group_id, request_options=request_options)
+        return _response.data

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/plans/raw_client.py

@@ -16,6 +16,7 @@ from ..errors.forbidden_error import ForbiddenError
 from ..errors.not_found_error import NotFoundError
 from ..types.error import Error
 from ..types.plan import Plan
+from ..types.plan_group import PlanGroup
 from ..types.usage_summaries_response import UsageSummariesResponse
 
 
@@ -180,6 +181,65 @@ class RawPlansClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    def get_group_by_id(
+        self, plan_group_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[PlanGroup]:
+        """
+        Parameters
+        ----------
+        plan_group_id : str
+            The ID of the plan group
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PlanGroup]
+            Success response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"plans/group/{jsonable_encoder(plan_group_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanGroup,
+                    parse_obj_as(
+                        type_=PlanGroup,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
 
 class AsyncRawPlansClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -343,3 +403,62 @@ class AsyncRawPlansClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_group_by_id(
+        self, plan_group_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[PlanGroup]:
+        """
+        Parameters
+        ----------
+        plan_group_id : str
+            The ID of the plan group
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PlanGroup]
+            Success response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"plans/group/{jsonable_encoder(plan_group_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PlanGroup,
+                    parse_obj_as(
+                        type_=PlanGroup,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        Error,
+                        parse_obj_as(
+                            type_=Error,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

{paid_python-0.5.0 → paid_python-0.6.0}/src/paid/types/__init__.py

@@ -29,6 +29,7 @@ from .order_line_attribute_pricing import OrderLineAttributePricing
 from .order_line_create import OrderLineCreate
 from .pagination_meta import PaginationMeta
 from .plan import Plan
+from .plan_group import PlanGroup
 from .plan_plan_products_item import PlanPlanProductsItem
 from .plan_plan_products_item_plan_product_attribute_item import PlanPlanProductsItemPlanProductAttributeItem
 from .price_point import PricePoint
@@ -79,6 +80,7 @@ __all__ = [
     "OrderLineCreate",
     "PaginationMeta",
     "Plan",
+    "PlanGroup",
     "PlanPlanProductsItem",
     "PlanPlanProductsItemPlanProductAttributeItem",
     "PricePoint",

paid_python-0.6.0/src/paid/types/plan_group.py

@@ -0,0 +1,60 @@
+# 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 .plan import Plan
+
+
+class PlanGroup(UniversalBaseModel):
+    """
+    A plan group containing multiple plans
+    """
+
+    id: str = pydantic.Field()
+    """
+    The unique identifier of the plan group
+    """
+
+    organization_id: typing_extensions.Annotated[str, FieldMetadata(alias="organizationId")] = pydantic.Field()
+    """
+    The organization ID that owns this plan group
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the plan group
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the plan group
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the plan group was created
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the plan group was last updated
+    """
+
+    plans: typing.Optional[typing.List[Plan]] = pydantic.Field(default=None)
+    """
+    The plans included in this plan group
+    """
+
+    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