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

paid/types/payment_method.py

@@ -0,0 +1,58 @@
+# 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 .payment_method_card import PaymentMethodCard
+from .payment_method_type import PaymentMethodType
+from .payment_method_us_bank_account import PaymentMethodUsBankAccount
+
+
+class PaymentMethod(UniversalBaseModel):
+    """
+    A customer's payment method
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The payment method ID (typically from Stripe)
+    """
+
+    type: typing.Optional[PaymentMethodType] = pydantic.Field(default=None)
+    """
+    The type of payment method
+    """
+
+    card: typing.Optional[PaymentMethodCard] = pydantic.Field(default=None)
+    """
+    Card details (present when type is 'card')
+    """
+
+    us_bank_account: typing_extensions.Annotated[
+        typing.Optional[PaymentMethodUsBankAccount], FieldMetadata(alias="usBankAccount")
+    ] = pydantic.Field(default=None)
+    """
+    US bank account details (present when type is 'us_bank_account')
+    """
+
+    is_default: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDefault")] = pydantic.Field(
+        default=None
+    )
+    """
+    Whether this is the customer's default payment method
+    """
+
+    created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = 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/payment_method_card.py

@@ -0,0 +1,49 @@
+# 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 PaymentMethodCard(UniversalBaseModel):
+    """
+    Card details (present when type is 'card')
+    """
+
+    brand: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Card brand (visa, mastercard, amex, etc.)
+    """
+
+    last_4: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="last4")] = pydantic.Field(
+        default=None
+    )
+    """
+    Last 4 digits of the card number
+    """
+
+    exp_month: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="expMonth")] = pydantic.Field(
+        default=None
+    )
+    """
+    Expiration month (1-12)
+    """
+
+    exp_year: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="expYear")] = pydantic.Field(
+        default=None
+    )
+    """
+    Expiration year
+    """
+
+    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/payment_method_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentMethodType = typing.Union[typing.Literal["card", "us_bank_account", "sepa_debit"], typing.Any]

paid/types/payment_method_us_bank_account.py

@@ -0,0 +1,36 @@
+# 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
+from .payment_method_us_bank_account_account_type import PaymentMethodUsBankAccountAccountType
+
+
+class PaymentMethodUsBankAccount(UniversalBaseModel):
+    """
+    US bank account details (present when type is 'us_bank_account')
+    """
+
+    bank_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="bankName")] = None
+    last_4: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="last4")] = pydantic.Field(
+        default=None
+    )
+    """
+    Last 4 digits of the account number
+    """
+
+    account_type: typing_extensions.Annotated[
+        typing.Optional[PaymentMethodUsBankAccountAccountType], FieldMetadata(alias="accountType")
+    ] = 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/payment_method_us_bank_account_account_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentMethodUsBankAccountAccountType = typing.Union[typing.Literal["checking", "savings"], typing.Any]

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

paid/types/plan_plan_products_item.py

@@ -8,6 +8,7 @@ import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
 from .plan_plan_products_item_plan_product_attribute_item import PlanPlanProductsItemPlanProductAttributeItem
+from .product import Product
 
 
 class PlanPlanProductsItem(UniversalBaseModel):
@@ -17,6 +18,11 @@ class PlanPlanProductsItem(UniversalBaseModel):
     product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productId")] = None
     created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
     updated_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="updatedAt")] = None
+    product: typing.Optional[Product] = pydantic.Field(default=None)
+    """
+    The product associated with this plan product
+    """
+
     plan_product_attribute: typing_extensions.Annotated[
         typing.Optional[typing.List[PlanPlanProductsItemPlanProductAttributeItem]],
         FieldMetadata(alias="planProductAttribute"),

paid/types/plan_with_features.py

@@ -0,0 +1,69 @@
+# 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_with_features_features_item import PlanWithFeaturesFeaturesItem
+
+
+class PlanWithFeatures(UniversalBaseModel):
+    """
+    A plan with its features (product-attribute pairs) for display
+    """
+
+    id: str = pydantic.Field()
+    """
+    The unique identifier of the plan
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the plan
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the plan
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the plan was created
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the plan was last updated
+    """
+
+    next_plan_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="nextPlanId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The ID of the next plan in the sequence
+    """
+
+    prev_plan_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="prevPlanId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The ID of the previous plan in the sequence
+    """
+
+    features: typing.List[PlanWithFeaturesFeaturesItem] = pydantic.Field()
+    """
+    The features (product-attribute pairs) included in this plan
+    """
+
+    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/plan_with_features_features_item.py

@@ -0,0 +1,34 @@
+# 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 PlanWithFeaturesFeaturesItem(UniversalBaseModel):
+    product_name: typing_extensions.Annotated[str, FieldMetadata(alias="productName")] = pydantic.Field()
+    """
+    The name of the product
+    """
+
+    attribute_name: typing_extensions.Annotated[str, FieldMetadata(alias="attributeName")] = pydantic.Field()
+    """
+    The name of the product attribute
+    """
+
+    pricing: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    The pricing configuration for this feature
+    """
+
+    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/proration_attribute_update.py

@@ -0,0 +1,44 @@
+# 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 ProrationAttributeUpdate(UniversalBaseModel):
+    """
+    An attribute update for a proration upgrade
+    """
+
+    order_line_attribute_id: typing_extensions.Annotated[str, FieldMetadata(alias="orderLineAttributeId")] = (
+        pydantic.Field()
+    )
+    """
+    The ID of the order line attribute to update
+    """
+
+    new_pricing: typing_extensions.Annotated[
+        typing.Dict[str, typing.Optional[typing.Any]], FieldMetadata(alias="newPricing")
+    ] = pydantic.Field()
+    """
+    The new pricing configuration
+    """
+
+    new_quantity: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="newQuantity")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Optional new quantity for the attribute
+    """
+
+    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/proration_detail.py

@@ -0,0 +1,49 @@
+# 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 ProrationDetail(UniversalBaseModel):
+    """
+    Details about the proration calculation for an attribute
+    """
+
+    old_attribute_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="oldAttributeId")] = None
+    new_attribute_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="newAttributeId")] = None
+    credit_line_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="creditLineId")] = None
+    old_price: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="oldPrice")] = None
+    new_price: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="newPrice")] = None
+    credit_amount: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="creditAmount")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The credit amount applied for the unused portion
+    """
+
+    remaining_days: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="remainingDays")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Number of days remaining in the current billing cycle
+    """
+
+    total_days_in_cycle: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="totalDaysInCycle")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Total number of days in the billing cycle
+    """
+
+    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/proration_upgrade_response.py

@@ -0,0 +1,73 @@
+# 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 .proration_detail import ProrationDetail
+
+
+class ProrationUpgradeResponse(UniversalBaseModel):
+    """
+    Response after successfully scheduling a plan change
+    """
+
+    order_id: typing_extensions.Annotated[str, FieldMetadata(alias="orderId")] = pydantic.Field()
+    """
+    The ID of the order
+    """
+
+    amendment_id: typing_extensions.Annotated[str, FieldMetadata(alias="amendmentId")] = pydantic.Field()
+    """
+    The ID of the amendment record
+    """
+
+    version: int = pydantic.Field()
+    """
+    The new version of the order after the amendment
+    """
+
+    effective_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="effectiveDate")] = pydantic.Field()
+    """
+    The effective date of the plan change
+    """
+
+    ended_line_ids: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="endedLineIds")] = (
+        pydantic.Field()
+    )
+    """
+    IDs of order lines that were ended
+    """
+
+    created_line_ids: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="createdLineIds")] = (
+        pydantic.Field()
+    )
+    """
+    IDs of new order lines that were created
+    """
+
+    credit_line_ids: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="creditLineIds")] = (
+        pydantic.Field()
+    )
+    """
+    IDs of credit lines that were created
+    """
+
+    proration_details: typing_extensions.Annotated[
+        typing.List[ProrationDetail], FieldMetadata(alias="prorationDetails")
+    ] = pydantic.Field()
+    """
+    Detailed proration calculations for each updated attribute
+    """
+
+    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/signal_v_2.py

@@ -8,7 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 class SignalV2(UniversalBaseModel):
     """
-    V2 signal schema with clean field names. Use either internal IDs (product_id, customer_id) or external IDs (external_product_id, external_customer_id).
+    V2 signal schema with clean field names. IMPORTANT: Exactly one customer ID field (customer_id OR external_customer_id) and exactly one product ID field (product_id OR external_product_id) must be provided per signal.
     """
 
     event_name: str = pydantic.Field()
@@ -18,22 +18,22 @@ class SignalV2(UniversalBaseModel):
 
     product_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Paid's internal product ID. Use either this OR external_product_id.
+    Paid's display ID for the product (e.g., prod_abc123). Cannot be used with external_product_id. Either this or external_product_id is required.
     """
 
     external_product_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Your system's product ID. Use either this OR product_id.
+    Your system's product ID. Cannot be used with product_id. Either this or product_id is required.
     """
 
     customer_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Paid's internal customer ID. Use either this OR external_customer_id.
+    Paid's display ID for the customer (e.g., cus_xyz789). Cannot be used with external_customer_id. Either this or external_customer_id is required.
     """
 
     external_customer_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Your system's customer ID. Use either this OR customer_id.
+    Your system's customer ID. Cannot be used with customer_id. Either this or customer_id is required.
     """
 
     data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)

paid/usage/client.py

@@ -91,8 +91,8 @@ class UsageClient:
             signals=[
                 SignalV2(
                     event_name="emails_sent",
-                    product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
-                    customer_id="7d0b6fce-d82a-433d-8315-c994f8f1d68d",
+                    product_id="prod_abc123def",
+                    customer_id="cus_xyz789ghi",
                 ),
                 SignalV2(
                     event_name="emails_sent",
@@ -101,7 +101,7 @@ class UsageClient:
                 ),
                 SignalV2(
                     event_name="meeting_booked",
-                    product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                    product_id="prod_abc123def",
                     external_customer_id="acme-inc",
                     data={"meeting_duration": 30, "meeting_type": "demo"},
                 ),
@@ -246,8 +246,8 @@ class AsyncUsageClient:
                 signals=[
                     SignalV2(
                         event_name="emails_sent",
-                        product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
-                        customer_id="7d0b6fce-d82a-433d-8315-c994f8f1d68d",
+                        product_id="prod_abc123def",
+                        customer_id="cus_xyz789ghi",
                     ),
                     SignalV2(
                         event_name="emails_sent",
@@ -256,7 +256,7 @@ class AsyncUsageClient:
                     ),
                     SignalV2(
                         event_name="meeting_booked",
-                        product_id="63fd642c-569d-44f9-8d67-5cf4944a16cc",
+                        product_id="prod_abc123def",
                         external_customer_id="acme-inc",
                         data={"meeting_duration": 30, "meeting_type": "demo"},
                     ),

{paid_python-0.5.0.dist-info → paid_python-1.0.0a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: paid-python
-Version: 0.5.0
+Version: 1.0.0a0
 Summary: 
 Requires-Python: >=3.9,<3.14
 Classifier: Intended Audience :: Developers
@@ -15,9 +15,10 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Dist: httpx (>=0.21.0)
+Requires-Dist: httpx (>=0.21.2)
 Requires-Dist: mutagen (>=1.47.0)
 Requires-Dist: openinference-instrumentation-bedrock (>=0.1.0)
 Requires-Dist: openinference-instrumentation-google-genai (>=0.1.8)
@@ -26,9 +27,10 @@ Requires-Dist: openinference-instrumentation-openai-agents (>=1.0.0)
 Requires-Dist: opentelemetry-api (>=1.23.0)
 Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.23.0)
 Requires-Dist: opentelemetry-instrumentation-anthropic (>=0.47.0)
+Requires-Dist: opentelemetry-instrumentation-openai (>=0.50.0)
 Requires-Dist: opentelemetry-sdk (>=1.23.0)
-Requires-Dist: pydantic (>=1.9.0)
-Requires-Dist: pydantic-core (>=2.18.0)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
 Requires-Dist: python-dotenv (>=0.15.0)
 Requires-Dist: typing_extensions (>=4.0.0)
 Description-Content-Type: text/markdown