sequenzy 2.0.0__py3-none-any.whl

sequenzy/types/commerce_customer.py

@@ -0,0 +1,41 @@
+# 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 CommerceCustomer(UniversalBaseModel):
+    attributes: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Custom subscriber attributes to merge into the profile. Synced to ClickHouse for segment filtering.
+    """
+
+    email: str
+    external_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="externalId"),
+        pydantic.Field(alias="externalId", description="Customer-owned app/customer/user ID"),
+    ] = None
+    """
+    Customer-owned app/customer/user ID
+    """
+
+    first_name: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="firstName"), pydantic.Field(alias="firstName")
+    ] = None
+    last_name: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="lastName"), pydantic.Field(alias="lastName")
+    ] = 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

sequenzy/types/commerce_forecast_range.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 CommerceForecastRange(UniversalBaseModel):
+    high_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="highCents"), pydantic.Field(alias="highCents")
+    ] = None
+    low_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="lowCents"), pydantic.Field(alias="lowCents")
+    ] = 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

sequenzy/types/commerce_order_item.py

@@ -0,0 +1,55 @@
+# 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 CommerceOrderItem(UniversalBaseModel):
+    price_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="priceCents"),
+        pydantic.Field(alias="priceCents", description="Unit price in cents"),
+    ] = None
+    """
+    Unit price in cents
+    """
+
+    product_id: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="productId"),
+        pydantic.Field(
+            alias="productId", description="Your product identifier (same value used when upserting products)"
+        ),
+    ]
+    """
+    Your product identifier (same value used when upserting products)
+    """
+
+    quantity: int
+    sku: typing.Optional[str] = None
+    title: str
+    variant_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="variantId"),
+        pydantic.Field(alias="variantId", description="Your variant identifier within the product"),
+    ] = None
+    """
+    Your variant identifier within the product
+    """
+
+    variant_title: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="variantTitle"), pydantic.Field(alias="variantTitle")
+    ] = 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

sequenzy/types/commerce_product.py

@@ -0,0 +1,99 @@
+# 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 .commerce_product_provider import CommerceProductProvider
+from .commerce_product_variants_item import CommerceProductVariantsItem
+from .product_digital_delivery import ProductDigitalDelivery
+
+
+class CommerceProduct(UniversalBaseModel):
+    compare_at_price: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="compareAtPrice"), pydantic.Field(alias="compareAtPrice")
+    ] = None
+    compare_at_price_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="compareAtPriceCents"), pydantic.Field(alias="compareAtPriceCents")
+    ] = None
+    created_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="createdAt"), pydantic.Field(alias="createdAt")
+    ] = None
+    currency: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    digital_delivery: typing_extensions.Annotated[
+        typing.Optional[ProductDigitalDelivery],
+        FieldMetadata(alias="digitalDelivery"),
+        pydantic.Field(alias="digitalDelivery"),
+    ] = None
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Internal Sequenzy product ID
+    """
+
+    image_url: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="imageUrl"), pydantic.Field(alias="imageUrl")
+    ] = None
+    in_stock: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="inStock"), pydantic.Field(alias="inStock")
+    ] = None
+    price: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Unit price in cents
+    """
+
+    price_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="priceCents"), pydantic.Field(alias="priceCents")
+    ] = None
+    product_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="productId"),
+        pydantic.Field(alias="productId", description="Your product identifier (providerProductId)"),
+    ] = None
+    """
+    Your product identifier (providerProductId)
+    """
+
+    provider: typing.Optional[CommerceProductProvider] = None
+    provider_created_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="providerCreatedAt"),
+        pydantic.Field(
+            alias="providerCreatedAt",
+            description="Product creation time reported by the source catalog. Used for newest-product ranking.",
+        ),
+    ] = None
+    """
+    Product creation time reported by the source catalog. Used for newest-product ranking.
+    """
+
+    provider_product_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="providerProductId"),
+        pydantic.Field(alias="providerProductId", description="Provider product identifier"),
+    ] = None
+    """
+    Provider product identifier
+    """
+
+    title: typing.Optional[str] = None
+    updated_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="updatedAt"), pydantic.Field(alias="updatedAt")
+    ] = None
+    url: typing.Optional[str] = None
+    variants: typing.Optional[typing.List[CommerceProductVariantsItem]] = pydantic.Field(default=None)
+    """
+    For Stripe products, every active Stripe price of the product (variantId is the Stripe price ID).
+    """
+
+    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

sequenzy/types/commerce_product_provider.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CommerceProductProvider = typing.Union[typing.Literal["api", "stripe", "shopify", "woocommerce", "manual"], typing.Any]

sequenzy/types/commerce_product_variants_item.py

@@ -0,0 +1,47 @@
+# 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 .commerce_product_variants_item_options_item import CommerceProductVariantsItemOptionsItem
+
+
+class CommerceProductVariantsItem(UniversalBaseModel):
+    compare_at_price_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="compareAtPriceCents"), pydantic.Field(alias="compareAtPriceCents")
+    ] = None
+    currency: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The variant's own currency. Stripe products can have active prices in several currencies, so this can differ from the product-level currency.
+    """
+
+    image_url: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="imageUrl"), pydantic.Field(alias="imageUrl")
+    ] = None
+    in_stock: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="inStock"), pydantic.Field(alias="inStock")
+    ] = None
+    inventory_quantity: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="inventoryQuantity"), pydantic.Field(alias="inventoryQuantity")
+    ] = None
+    options: typing.Optional[typing.List[CommerceProductVariantsItemOptionsItem]] = None
+    price_cents: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="priceCents"), pydantic.Field(alias="priceCents")
+    ] = None
+    sku: typing.Optional[str] = None
+    title: typing.Optional[str] = None
+    variant_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="variantId"), pydantic.Field(alias="variantId")
+    ] = 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

sequenzy/types/commerce_product_variants_item_options_item.py

@@ -0,0 +1,20 @@
+# 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 CommerceProductVariantsItemOptionsItem(UniversalBaseModel):
+    name: typing.Optional[str] = None
+    value: typing.Optional[str] = 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

sequenzy/types/commerce_value_forecast.py

@@ -0,0 +1,47 @@
+# 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 .commerce_value_forecast_actual import CommerceValueForecastActual
+from .commerce_value_forecast_confidence import CommerceValueForecastConfidence
+from .commerce_value_forecast_eligibility import CommerceValueForecastEligibility
+from .commerce_value_forecast_forecast import CommerceValueForecastForecast
+from .commerce_value_forecast_history import CommerceValueForecastHistory
+from .commerce_value_forecast_status import CommerceValueForecastStatus
+
+
+class CommerceValueForecast(UniversalBaseModel):
+    """
+    Explainable commerce forecast derived from up to two years of provider-neutral placed-order events.
+    """
+
+    actual: typing.Optional[CommerceValueForecastActual] = None
+    confidence: typing.Optional[CommerceValueForecastConfidence] = None
+    currency: typing.Optional[str] = None
+    eligibility: typing.Optional[CommerceValueForecastEligibility] = None
+    forecast: typing.Optional[CommerceValueForecastForecast] = None
+    generated_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="generatedAt"), pydantic.Field(alias="generatedAt")
+    ] = None
+    history: typing.Optional[CommerceValueForecastHistory] = None
+    is_sampled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="isSampled"), pydantic.Field(alias="isSampled")
+    ] = None
+    model_version: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="modelVersion"), pydantic.Field(alias="modelVersion")
+    ] = None
+    status: typing.Optional[CommerceValueForecastStatus] = 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

sequenzy/types/commerce_value_forecast_actual.py

@@ -0,0 +1,33 @@
+# 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 CommerceValueForecastActual(UniversalBaseModel):
+    average_customer_value_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="averageCustomerValueCents"),
+        pydantic.Field(alias="averageCustomerValueCents"),
+    ] = None
+    average_order_value_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="averageOrderValueCents"),
+        pydantic.Field(alias="averageOrderValueCents"),
+    ] = None
+    repeat_purchase_rate: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="repeatPurchaseRate"), pydantic.Field(alias="repeatPurchaseRate")
+    ] = 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

sequenzy/types/commerce_value_forecast_confidence.py

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

sequenzy/types/commerce_value_forecast_eligibility.py

@@ -0,0 +1,20 @@
+# 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 .commerce_value_forecast_eligibility_reasons_item import CommerceValueForecastEligibilityReasonsItem
+
+
+class CommerceValueForecastEligibility(UniversalBaseModel):
+    reasons: typing.Optional[typing.List[CommerceValueForecastEligibilityReasonsItem]] = 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

sequenzy/types/commerce_value_forecast_eligibility_reasons_item.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 CommerceValueForecastEligibilityReasonsItem(UniversalBaseModel):
+    code: typing.Optional[str] = None
+    current: typing.Optional[float] = None
+    message: typing.Optional[str] = None
+    required: typing.Optional[float] = 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

sequenzy/types/commerce_value_forecast_forecast.py

@@ -0,0 +1,56 @@
+# 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 .commerce_forecast_range import CommerceForecastRange
+
+
+class CommerceValueForecastForecast(UniversalBaseModel):
+    expected_orders90days: typing_extensions.Annotated[
+        typing.Optional[float],
+        FieldMetadata(alias="expectedOrders90Days"),
+        pydantic.Field(alias="expectedOrders90Days"),
+    ] = None
+    expected_revenue90days_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="expectedRevenue90DaysCents"),
+        pydantic.Field(alias="expectedRevenue90DaysCents"),
+    ] = None
+    expected_revenue90days_range: typing_extensions.Annotated[
+        typing.Optional[CommerceForecastRange],
+        FieldMetadata(alias="expectedRevenue90DaysRange"),
+        pydantic.Field(alias="expectedRevenue90DaysRange"),
+    ] = None
+    predicted_average_order_value_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="predictedAverageOrderValueCents"),
+        pydantic.Field(alias="predictedAverageOrderValueCents"),
+    ] = None
+    predicted_average_order_value_range: typing_extensions.Annotated[
+        typing.Optional[CommerceForecastRange],
+        FieldMetadata(alias="predictedAverageOrderValueRange"),
+        pydantic.Field(alias="predictedAverageOrderValueRange"),
+    ] = None
+    predicted_customer_value365days_cents: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="predictedCustomerValue365DaysCents"),
+        pydantic.Field(alias="predictedCustomerValue365DaysCents"),
+    ] = None
+    predicted_customer_value365days_range: typing_extensions.Annotated[
+        typing.Optional[CommerceForecastRange],
+        FieldMetadata(alias="predictedCustomerValue365DaysRange"),
+        pydantic.Field(alias="predictedCustomerValue365DaysRange"),
+    ] = 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

sequenzy/types/commerce_value_forecast_history.py

@@ -0,0 +1,40 @@
+# 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 CommerceValueForecastHistory(UniversalBaseModel):
+    customer_count: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="customerCount"), pydantic.Field(alias="customerCount")
+    ] = None
+    days_since_last_order: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="daysSinceLastOrder"), pydantic.Field(alias="daysSinceLastOrder")
+    ] = None
+    excluded_currency_order_count: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="excludedCurrencyOrderCount"),
+        pydantic.Field(alias="excludedCurrencyOrderCount"),
+    ] = None
+    history_days: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="historyDays"), pydantic.Field(alias="historyDays")
+    ] = None
+    order_count: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="orderCount"), pydantic.Field(alias="orderCount")
+    ] = None
+    repeat_customer_count: typing_extensions.Annotated[
+        typing.Optional[int], FieldMetadata(alias="repeatCustomerCount"), pydantic.Field(alias="repeatCustomerCount")
+    ] = 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

sequenzy/types/commerce_value_forecast_status.py

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