dub 0.27.2__py3-none-any.whl → 0.27.3__py3-none-any.whl

dub/models/components/saleevent.py

@@ -6,7 +6,7 @@ from dub.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTIN
 from enum import Enum
 import pydantic
 from pydantic import model_serializer
-from typing import List, Optional
+from typing import Any, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -14,6 +14,71 @@ class SaleEventEvent(str, Enum):
     SALE = "sale"
 
 
+class PaymentProcessor(str, Enum):
+    r"""The payment processor via which the sale was made."""
+
+    STRIPE = "stripe"
+    SHOPIFY = "shopify"
+    POLAR = "polar"
+    PADDLE = "paddle"
+    REVENUECAT = "revenuecat"
+    CUSTOM = "custom"
+
+
+class SaleTypedDict(TypedDict):
+    amount: int
+    r"""The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency"""
+    payment_processor: PaymentProcessor
+    r"""The payment processor via which the sale was made."""
+    invoice_id: NotRequired[Nullable[str]]
+    r"""The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID."""
+
+
+class Sale(BaseModel):
+    amount: int
+    r"""The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency"""
+
+    payment_processor: Annotated[
+        PaymentProcessor, pydantic.Field(alias="paymentProcessor")
+    ]
+    r"""The payment processor via which the sale was made."""
+
+    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
+        None
+    )
+    r"""The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["invoiceId"]
+        nullable_fields = ["invoiceId"]
+        null_default_fields = ["invoiceId"]
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
+
 class SaleEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
 
@@ -824,8 +889,6 @@ class SaleEventLinkTypedDict(TypedDict):
     geo: Nullable[SaleEventGeoTypedDict]
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
     public_stats: bool
-    tag_id: Nullable[str]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
     tags: Nullable[List[TagSchemaTypedDict]]
     r"""The tags assigned to the short link."""
     folder_id: Nullable[str]
@@ -856,18 +919,22 @@ class SaleEventLinkTypedDict(TypedDict):
     last_clicked: str
     created_at: str
     updated_at: str
+    tag_id: Nullable[str]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
     project_id: str
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
     test_variants: NotRequired[Nullable[List[SaleEventTestVariantsTypedDict]]]
     r"""An array of A/B test URLs and the percentage of traffic to send to each URL."""
     clicks: NotRequired[float]
     r"""The number of clicks on the short link."""
     leads: NotRequired[float]
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+    conversions: NotRequired[float]
+    r"""The number of leads that converted to paying customers."""
     sales: NotRequired[float]
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
     sale_amount: NotRequired[float]
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
 
 class SaleEventLink(BaseModel):
@@ -934,15 +1001,6 @@ class SaleEventLink(BaseModel):
 
     public_stats: Annotated[bool, pydantic.Field(alias="publicStats")]
 
-    tag_id: Annotated[
-        Nullable[str],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="tagId",
-        ),
-    ]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
-
     tags: Nullable[List[TagSchema]]
     r"""The tags assigned to the short link."""
 
@@ -991,6 +1049,15 @@ class SaleEventLink(BaseModel):
 
     updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
 
+    tag_id: Annotated[
+        Nullable[str],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="tagId",
+        ),
+    ]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
+
     project_id: Annotated[
         str,
         pydantic.Field(
@@ -998,7 +1065,7 @@ class SaleEventLink(BaseModel):
             alias="projectId",
         ),
     ]
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
 
     test_variants: Annotated[
         OptionalNullable[List[SaleEventTestVariants]],
@@ -1010,17 +1077,27 @@ class SaleEventLink(BaseModel):
     r"""The number of clicks on the short link."""
 
     leads: Optional[float] = 0
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+
+    conversions: Optional[float] = 0
+    r"""The number of leads that converted to paying customers."""
 
     sales: Optional[float] = 0
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["testVariants", "clicks", "leads", "sales", "saleAmount"]
+        optional_fields = [
+            "testVariants",
+            "clicks",
+            "leads",
+            "conversions",
+            "sales",
+            "saleAmount",
+        ]
         nullable_fields = [
             "externalId",
             "tenantId",
@@ -1035,7 +1112,6 @@ class SaleEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1048,6 +1124,7 @@ class SaleEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 
@@ -1091,6 +1168,7 @@ class SaleEventClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class SaleEventClick(BaseModel):
@@ -1122,6 +1200,38 @@ class SaleEventClick(BaseModel):
 
     ip: str
 
+    trigger: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["trigger"]
+        nullable_fields = ["trigger"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m
+
 
 class SaleEventCustomerTypedDict(TypedDict):
     id: str
@@ -1205,112 +1315,48 @@ class SaleEventCustomer(BaseModel):
         return m
 
 
-class PaymentProcessor(str, Enum):
-    r"""The payment processor via which the sale was made."""
-
-    STRIPE = "stripe"
-    SHOPIFY = "shopify"
-    POLAR = "polar"
-    PADDLE = "paddle"
-    REVENUECAT = "revenuecat"
-    CUSTOM = "custom"
-
-
-class SaleTypedDict(TypedDict):
-    amount: int
-    r"""The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency"""
-    payment_processor: PaymentProcessor
-    r"""The payment processor via which the sale was made."""
-    invoice_id: NotRequired[Nullable[str]]
-    r"""The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID."""
-
-
-class Sale(BaseModel):
-    amount: int
-    r"""The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency"""
-
-    payment_processor: Annotated[
-        PaymentProcessor, pydantic.Field(alias="paymentProcessor")
-    ]
-    r"""The payment processor via which the sale was made."""
-
-    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
-        None
-    )
-    r"""The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID."""
-
-    @model_serializer(mode="wrap")
-    def serialize_model(self, handler):
-        optional_fields = ["invoiceId"]
-        nullable_fields = ["invoiceId"]
-        null_default_fields = ["invoiceId"]
-
-        serialized = handler(self)
-
-        m = {}
-
-        for n, f in type(self).model_fields.items():
-            k = f.alias or n
-            val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
-
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
-
-        return m
-
-
 class SaleEventTypedDict(TypedDict):
     event: SaleEventEvent
     timestamp: str
     event_id: str
     event_name: str
+    sale: SaleTypedDict
     link: SaleEventLinkTypedDict
     click: SaleEventClickTypedDict
     customer: SaleEventCustomerTypedDict
-    sale: SaleTypedDict
     sale_amount: float
-    r"""Deprecated. Use `sale.amount` instead."""
+    r"""Deprecated: Use `sale.amount` instead."""
     invoice_id: str
-    r"""Deprecated. Use `sale.invoiceId` instead."""
+    r"""Deprecated: Use `sale.invoiceId` instead."""
     payment_processor: str
-    r"""Deprecated. Use `sale.paymentProcessor` instead."""
+    r"""Deprecated: Use `sale.paymentProcessor` instead."""
     click_id: str
-    r"""Deprecated. Use `click.id` instead."""
+    r"""Deprecated: Use `click.id` instead."""
     link_id: str
-    r"""Deprecated. Use `link.id` instead."""
+    r"""Deprecated: Use `link.id` instead."""
     domain: str
-    r"""Deprecated. Use `link.domain` instead."""
+    r"""Deprecated: Use `link.domain` instead."""
     key: str
-    r"""Deprecated. Use `link.key` instead."""
+    r"""Deprecated: Use `link.key` instead."""
     url: str
-    r"""Deprecated. Use `click.url` instead."""
+    r"""Deprecated: Use `click.url` instead."""
     continent: str
-    r"""Deprecated. Use `click.continent` instead."""
+    r"""Deprecated: Use `click.continent` instead."""
     country: str
-    r"""Deprecated. Use `click.country` instead."""
+    r"""Deprecated: Use `click.country` instead."""
     city: str
-    r"""Deprecated. Use `click.city` instead."""
+    r"""Deprecated: Use `click.city` instead."""
     device: str
-    r"""Deprecated. Use `click.device` instead."""
+    r"""Deprecated: Use `click.device` instead."""
     browser: str
-    r"""Deprecated. Use `click.browser` instead."""
+    r"""Deprecated: Use `click.browser` instead."""
     os: str
-    r"""Deprecated. Use `click.os` instead."""
+    r"""Deprecated: Use `click.os` instead."""
     qr: float
-    r"""Deprecated. Use `click.qr` instead."""
+    r"""Deprecated: Use `click.qr` instead."""
     ip: str
-    r"""Deprecated. Use `click.ip` instead."""
+    r"""Deprecated: Use `click.ip` instead."""
+    metadata: NotRequired[Nullable[Any]]
 
 
 class SaleEvent(BaseModel):
@@ -1322,14 +1368,14 @@ class SaleEvent(BaseModel):
 
     event_name: Annotated[str, pydantic.Field(alias="eventName")]
 
+    sale: Sale
+
     link: SaleEventLink
 
     click: SaleEventClick
 
     customer: SaleEventCustomer
 
-    sale: Sale
-
     sale_amount: Annotated[
         float,
         pydantic.Field(
@@ -1337,7 +1383,7 @@ class SaleEvent(BaseModel):
             alias="saleAmount",
         ),
     ]
-    r"""Deprecated. Use `sale.amount` instead."""
+    r"""Deprecated: Use `sale.amount` instead."""
 
     invoice_id: Annotated[
         str,
@@ -1345,10 +1391,15 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `sale.invoiceId` instead."""
+    r"""Deprecated: Use `sale.invoiceId` instead."""
 
-    payment_processor: str
-    r"""Deprecated. Use `sale.paymentProcessor` instead."""
+    payment_processor: Annotated[
+        str,
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+        ),
+    ]
+    r"""Deprecated: Use `sale.paymentProcessor` instead."""
 
     click_id: Annotated[
         str,
@@ -1356,7 +1407,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.id` instead."""
+    r"""Deprecated: Use `click.id` instead."""
 
     link_id: Annotated[
         str,
@@ -1364,7 +1415,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.id` instead."""
+    r"""Deprecated: Use `link.id` instead."""
 
     domain: Annotated[
         str,
@@ -1372,7 +1423,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.domain` instead."""
+    r"""Deprecated: Use `link.domain` instead."""
 
     key: Annotated[
         str,
@@ -1380,7 +1431,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.key` instead."""
+    r"""Deprecated: Use `link.key` instead."""
 
     url: Annotated[
         str,
@@ -1388,7 +1439,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.url` instead."""
+    r"""Deprecated: Use `click.url` instead."""
 
     continent: Annotated[
         str,
@@ -1396,7 +1447,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.continent` instead."""
+    r"""Deprecated: Use `click.continent` instead."""
 
     country: Annotated[
         str,
@@ -1404,7 +1455,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.country` instead."""
+    r"""Deprecated: Use `click.country` instead."""
 
     city: Annotated[
         str,
@@ -1412,7 +1463,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.city` instead."""
+    r"""Deprecated: Use `click.city` instead."""
 
     device: Annotated[
         str,
@@ -1420,7 +1471,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.device` instead."""
+    r"""Deprecated: Use `click.device` instead."""
 
     browser: Annotated[
         str,
@@ -1428,7 +1479,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.browser` instead."""
+    r"""Deprecated: Use `click.browser` instead."""
 
     os: Annotated[
         str,
@@ -1436,7 +1487,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.os` instead."""
+    r"""Deprecated: Use `click.os` instead."""
 
     qr: Annotated[
         float,
@@ -1444,7 +1495,7 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.qr` instead."""
+    r"""Deprecated: Use `click.qr` instead."""
 
     ip: Annotated[
         str,
@@ -1452,4 +1503,36 @@ class SaleEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.ip` instead."""
+    r"""Deprecated: Use `click.ip` instead."""
+
+    metadata: OptionalNullable[Any] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["metadata"]
+        nullable_fields = ["metadata"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

dub/models/errors/__init__.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING
 from importlib import import_module
+import builtins
 
 if TYPE_CHECKING:
     from .badrequest import BadRequest, BadRequestData, Code, Error, ErrorTypedDict
@@ -193,5 +194,5 @@ def __getattr__(attr_name: str) -> object:
 
 
 def __dir__():
-    lazy_attrs = list(_dynamic_imports.keys())
-    return sorted(lazy_attrs)
+    lazy_attrs = builtins.list(_dynamic_imports.keys())
+    return builtins.sorted(lazy_attrs)

dub/models/operations/__init__.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING
 from importlib import import_module
+import builtins
 
 if TYPE_CHECKING:
     from .bulkcreatelinks import (
@@ -1121,5 +1122,5 @@ def __getattr__(attr_name: str) -> object:
 
 
 def __dir__():
-    lazy_attrs = list(_dynamic_imports.keys())
-    return sorted(lazy_attrs)
+    lazy_attrs = builtins.list(_dynamic_imports.keys())
+    return builtins.sorted(lazy_attrs)