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

dub/models/components/linkwebhookevent.py

@@ -840,8 +840,6 @@ class LinkWebhookEventLinkTypedDict(TypedDict):
     geo: Nullable[LinkWebhookEventGeoTypedDict]
     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]
@@ -872,18 +870,22 @@ class LinkWebhookEventLinkTypedDict(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[LinkWebhookEventTestVariantsTypedDict]]]
     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 LinkWebhookEventLink(BaseModel):
@@ -950,15 +952,6 @@ class LinkWebhookEventLink(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."""
 
@@ -1007,6 +1000,15 @@ class LinkWebhookEventLink(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(
@@ -1014,7 +1016,7 @@ class LinkWebhookEventLink(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[LinkWebhookEventTestVariants]],
@@ -1026,17 +1028,27 @@ class LinkWebhookEventLink(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",
@@ -1051,7 +1063,6 @@ class LinkWebhookEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1064,6 +1075,7 @@ class LinkWebhookEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/components/partnerenrolledevent.py

@@ -39,11 +39,11 @@ class PartnerEnrolledEventLinkTypedDict(TypedDict):
     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."""
     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 PartnerEnrolledEventLink(BaseModel):
@@ -66,13 +66,13 @@ class PartnerEnrolledEventLink(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."""
 
     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."""
 
 
 class BannedReason(str, Enum):

dub/models/components/salecreatedevent.py

@@ -111,6 +111,7 @@ class SaleCreatedEventClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class SaleCreatedEventClick(BaseModel):
@@ -142,6 +143,38 @@ class SaleCreatedEventClick(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 SaleCreatedEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
@@ -953,8 +986,6 @@ class SaleCreatedEventLinkTypedDict(TypedDict):
     geo: Nullable[SaleCreatedEventGeoTypedDict]
     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]
@@ -985,18 +1016,22 @@ class SaleCreatedEventLinkTypedDict(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[SaleCreatedEventTestVariantsTypedDict]]]
     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 SaleCreatedEventLink(BaseModel):
@@ -1063,15 +1098,6 @@ class SaleCreatedEventLink(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."""
 
@@ -1120,6 +1146,15 @@ class SaleCreatedEventLink(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(
@@ -1127,7 +1162,7 @@ class SaleCreatedEventLink(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[SaleCreatedEventTestVariants]],
@@ -1139,17 +1174,27 @@ class SaleCreatedEventLink(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",
@@ -1164,7 +1209,6 @@ class SaleCreatedEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1177,6 +1221,7 @@ class SaleCreatedEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []