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

paid/types/order_line_create.py

@@ -6,22 +6,36 @@ import pydantic
 import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from .order_line_attribute_create import OrderLineAttributeCreate
+from .order_line_attribute_create_one import OrderLineAttributeCreateOne
 
 
 class OrderLineCreate(UniversalBaseModel):
+    product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Paid's internal ID for the product
+    """
+
+    product_external_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productExternalId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The external ID of the product i.e. the id within your system
+    """
+
     agent_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="agentId")] = pydantic.Field(
         default=None
     )
     """
-    Paid's internal ID for the agent/product
+    DEPRECATED: Use productId instead. Paid's internal ID for the agent/product
     """
 
     agent_external_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="agentExternalId")] = (
         pydantic.Field(default=None)
     )
     """
-    The external ID of the agent/product i.e. the id within your system
+    DEPRECATED: Use productExternalId instead. The external ID of the agent/product i.e. the id within your system
     """
 
     name: typing.Optional[str] = pydantic.Field(default=None)
@@ -34,11 +48,18 @@ class OrderLineCreate(UniversalBaseModel):
     Description of the order line
     """
 
+    product_attribute: typing_extensions.Annotated[
+        typing.Optional[typing.List[OrderLineAttributeCreateOne]], FieldMetadata(alias="ProductAttribute")
+    ] = pydantic.Field(default=None)
+    """
+    Optional array of custom product attributes to override default pricing, allowing per customer pricing. If not provided, attributes will be auto-generated from the product definition.
+    """
+
     agent_attributes: typing_extensions.Annotated[
-        typing.Optional[typing.List[OrderLineAttributeCreate]], FieldMetadata(alias="agentAttributes")
+        typing.Optional[typing.List[OrderLineAttributeCreateOne]], FieldMetadata(alias="agentAttributes")
     ] = pydantic.Field(default=None)
     """
-    Optional array of custom agent attributes to override default pricing, allowing per customer pricing. If not provided, attributes will be auto-generated from the product definition.
+    DEPRECATED: Use ProductAttribute instead. Optional array of custom agent attributes to override default pricing, allowing per customer pricing. If not provided, attributes will be auto-generated from the product definition.
     """
 
     if IS_PYDANTIC_V2:

paid/types/pagination_meta.py

@@ -48,6 +48,32 @@ class PaginationMeta(UniversalBaseModel):
     The endTime filter that was applied (if any)
     """
 
+    external_customer_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="externalCustomerId")
+    ] = pydantic.Field(default=None)
+    """
+    The externalCustomerId filter that was applied (if any)
+    """
+
+    external_product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="externalProductId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The externalProductId filter that was applied (if any)
+    """
+
+    external_agent_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="externalAgentId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    DEPRECATED: Use externalProductId instead. The externalAgentId filter that was applied (if any)
+    """
+
+    metadata: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The metadata filter that was applied (if any)
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

paid/types/plan.py

@@ -0,0 +1,81 @@
+# 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_plan_products_item import PlanPlanProductsItem
+
+
+class Plan(UniversalBaseModel):
+    """
+    A plan containing products and their attributes
+    """
+
+    id: str = pydantic.Field()
+    """
+    The unique identifier of the plan
+    """
+
+    organization_id: typing_extensions.Annotated[str, FieldMetadata(alias="organizationId")] = pydantic.Field()
+    """
+    The organization ID that owns this plan
+    """
+
+    plan_group_id: typing_extensions.Annotated[str, FieldMetadata(alias="planGroupId")] = pydantic.Field()
+    """
+    The plan group ID this plan belongs to
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the plan
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the plan
+    """
+
+    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
+    """
+
+    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
+    """
+
+    plan_products: typing_extensions.Annotated[
+        typing.Optional[typing.List[PlanPlanProductsItem]], FieldMetadata(alias="planProducts")
+    ] = pydantic.Field(default=None)
+    """
+    The products 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_plan_products_item.py

@@ -0,0 +1,35 @@
+# 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_plan_products_item_plan_product_attribute_item import PlanPlanProductsItemPlanProductAttributeItem
+
+
+class PlanPlanProductsItem(UniversalBaseModel):
+    id: typing.Optional[str] = None
+    organization_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="organizationId")] = None
+    plan_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="planId")] = None
+    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
+    plan_product_attribute: typing_extensions.Annotated[
+        typing.Optional[typing.List[PlanPlanProductsItemPlanProductAttributeItem]],
+        FieldMetadata(alias="planProductAttribute"),
+    ] = pydantic.Field(default=None)
+    """
+    The product attributes with pricing for 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_plan_products_item_plan_product_attribute_item.py

@@ -0,0 +1,34 @@
+# 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
+
+
+class PlanPlanProductsItemPlanProductAttributeItem(UniversalBaseModel):
+    id: typing.Optional[str] = None
+    organization_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="organizationId")] = None
+    plan_product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="planProductId")] = None
+    product_attribute_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="productAttributeId")
+    ] = None
+    pricing: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    The pricing configuration for this attribute
+    """
+
+    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
+
+    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/product.py

@@ -0,0 +1,56 @@
+# 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 .agent_attribute import AgentAttribute
+from .product_type import ProductType
+
+
+class Product(UniversalBaseModel):
+    """
+    A product in the Paid system (previously called Agent)
+    """
+
+    id: str
+    external_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="externalId")] = None
+    display_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Human-readable display ID
+    """
+
+    organization_id: typing_extensions.Annotated[str, FieldMetadata(alias="organizationId")]
+    name: str
+    description: typing.Optional[str] = None
+    type: ProductType = pydantic.Field()
+    """
+    The type of product
+    """
+
+    active: bool
+    product_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productCode")] = None
+    product_attribute: typing_extensions.Annotated[
+        typing.Optional[typing.List[AgentAttribute]], FieldMetadata(alias="ProductAttribute")
+    ] = pydantic.Field(default=None)
+    """
+    Pricing attributes for this product
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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
+
+    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/product_type.py

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

paid/types/product_update.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 .agent_attribute import AgentAttribute
+from .product_update_type import ProductUpdateType
+
+
+class ProductUpdate(UniversalBaseModel):
+    name: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    external_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="externalId")] = None
+    type: typing.Optional[ProductUpdateType] = None
+    active: typing.Optional[bool] = None
+    product_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productCode")] = None
+    product_attribute: typing_extensions.Annotated[
+        typing.Optional[typing.List[AgentAttribute]], FieldMetadata(alias="ProductAttribute")
+    ] = pydantic.Field(default=None)
+    """
+    Pricing attributes for this product
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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/product_update_type.py

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

paid/types/signal.py

@@ -7,12 +7,24 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class Signal(UniversalBaseModel):
+    """
+    DEPRECATED: Use SignalV2 instead for cleaner field names.
+    """
+
     event_name: typing.Optional[str] = None
-    agent_id: typing.Optional[str] = None
-    external_agent_id: typing.Optional[str] = None
-    customer_id: typing.Optional[str] = None
+    agent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    DEPRECATED: Use product_id in SignalV2 instead.
+    """
+
+    external_agent_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    DEPRECATED: Use external_product_id in SignalV2 instead.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Deprecated. The external customer id. Use `external_customer_id` or `internal_customer_id` instead.
+    DEPRECATED: The external customer id. Use `external_customer_id` or `internal_customer_id` instead.
     """
 
     data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
@@ -23,7 +35,7 @@ class Signal(UniversalBaseModel):
 
     internal_customer_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Paid's internal customer ID
+    DEPRECATED: Use customer_id in SignalV2 instead. This was Paid's internal customer ID.
     """
 
     external_customer_id: typing.Optional[str] = pydantic.Field(default=None)

paid/types/signal_v_2.py

@@ -0,0 +1,56 @@
+# 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 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).
+    """
+
+    event_name: str = pydantic.Field()
+    """
+    The name of the event being tracked
+    """
+
+    product_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Paid's internal product ID. Use either this OR external_product_id.
+    """
+
+    external_product_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Your system's product ID. Use either this OR product_id.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Paid's internal customer ID. Use either this OR external_customer_id.
+    """
+
+    external_customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Your system's customer ID. Use either this OR customer_id.
+    """
+
+    data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Optional additional data/metadata for the signal
+    """
+
+    idempotency_key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A unique key to ensure idempotent signal processing
+    """
+
+    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/trace.py

@@ -0,0 +1,69 @@
+# 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 .cost_amount import CostAmount
+
+
+class Trace(UniversalBaseModel):
+    """
+    A single cost trace record with customer and product info
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name/type of the operation (e.g., "trace.openai.agents.on_agent")
+    """
+
+    vendor: str = pydantic.Field()
+    """
+    The vendor/provider (e.g., "openai", "anthropic", "mistral")
+    """
+
+    model: str = pydantic.Field()
+    """
+    The model used for the operation (e.g., "gpt-4o-mini", "claude-3-sonnet")
+    """
+
+    cost: CostAmount
+    start_time_unix_nano: typing_extensions.Annotated[str, FieldMetadata(alias="startTimeUnixNano")] = pydantic.Field()
+    """
+    Unix timestamp in nanoseconds when the operation started
+    """
+
+    end_time_unix_nano: typing_extensions.Annotated[str, FieldMetadata(alias="endTimeUnixNano")] = pydantic.Field()
+    """
+    Unix timestamp in nanoseconds when the operation completed
+    """
+
+    attributes: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    Additional metadata about the trace (e.g., tokens, etc.)
+    """
+
+    customer_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customerId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The internal customer ID associated with this trace
+    """
+
+    product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productId")] = pydantic.Field(
+        default=None
+    )
+    """
+    The product/agent ID associated with this trace (optional)
+    """
+
+    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/traces_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .pagination_meta import PaginationMeta
+from .trace import Trace
+
+
+class TracesResponse(UniversalBaseModel):
+    """
+    Response containing cost traces and pagination metadata
+    """
+
+    traces: typing.List[Trace]
+    meta: PaginationMeta
+
+    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/{order_line_attribute_create.py → usage_pagination_meta.py}

@@ -6,23 +6,31 @@ import pydantic
 import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from .order_line_attribute_pricing import OrderLineAttributePricing
 
 
-class OrderLineAttributeCreate(UniversalBaseModel):
-    agent_attribute_name: typing_extensions.Annotated[str, FieldMetadata(alias="agentAttributeName")] = pydantic.Field()
+class UsagePaginationMeta(UniversalBaseModel):
     """
-    The name of the agent attribute to override (e.g., "api_call", "call_placed")
+    Pagination metadata for usage summaries
     """
 
-    quantity: typing.Optional[float] = pydantic.Field(default=None)
+    limit: int = pydantic.Field()
     """
-    Quantity for this attribute (defaults to 0)
+    The requested limit
     """
 
-    pricing: OrderLineAttributePricing = pydantic.Field()
+    offset: int = pydantic.Field()
     """
-    Custom pricing configuration for this attribute
+    The requested offset
+    """
+
+    total: int = pydantic.Field()
+    """
+    Total number of usage summaries available
+    """
+
+    has_more: typing_extensions.Annotated[bool, FieldMetadata(alias="hasMore")] = pydantic.Field()
+    """
+    Whether there are more results available
     """
 
     if IS_PYDANTIC_V2:

paid/types/usage_summaries_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .usage_pagination_meta import UsagePaginationMeta
+from .usage_summary import UsageSummary
+
+
+class UsageSummariesResponse(UniversalBaseModel):
+    """
+    Response containing usage summaries and pagination metadata
+    """
+
+    data: typing.List[UsageSummary]
+    pagination: UsagePaginationMeta
+
+    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