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

dub/models/components/leadevent.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
 
 
@@ -29,6 +29,7 @@ class LeadEventClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class LeadEventClick(BaseModel):
@@ -60,6 +61,38 @@ class LeadEventClick(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 LeadEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
@@ -871,8 +904,6 @@ class LeadEventLinkTypedDict(TypedDict):
     geo: Nullable[LeadEventGeoTypedDict]
     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]
@@ -903,18 +934,22 @@ class LeadEventLinkTypedDict(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[LeadEventTestVariantsTypedDict]]]
     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 LeadEventLink(BaseModel):
@@ -981,15 +1016,6 @@ class LeadEventLink(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."""
 
@@ -1038,6 +1064,15 @@ class LeadEventLink(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(
@@ -1045,7 +1080,7 @@ class LeadEventLink(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[LeadEventTestVariants]],
@@ -1057,17 +1092,27 @@ class LeadEventLink(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",
@@ -1082,7 +1127,6 @@ class LeadEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1095,6 +1139,7 @@ class LeadEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 
@@ -1214,31 +1259,32 @@ class LeadEventTypedDict(TypedDict):
     link: LeadEventLinkTypedDict
     customer: CustomerTypedDict
     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 LeadEvent(BaseModel):
@@ -1262,7 +1308,7 @@ class LeadEvent(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,
@@ -1270,7 +1316,7 @@ class LeadEvent(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,
@@ -1278,7 +1324,7 @@ class LeadEvent(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,
@@ -1286,7 +1332,7 @@ class LeadEvent(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,
@@ -1294,7 +1340,7 @@ class LeadEvent(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,
@@ -1302,7 +1348,7 @@ class LeadEvent(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,
@@ -1310,7 +1356,7 @@ class LeadEvent(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,
@@ -1318,7 +1364,7 @@ class LeadEvent(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,
@@ -1326,7 +1372,7 @@ class LeadEvent(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,
@@ -1334,7 +1380,7 @@ class LeadEvent(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,
@@ -1342,7 +1388,7 @@ class LeadEvent(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,
@@ -1350,7 +1396,7 @@ class LeadEvent(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,
@@ -1358,4 +1404,36 @@ class LeadEvent(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/components/linkclickedevent.py

@@ -29,6 +29,7 @@ class LinkClickedEventClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class LinkClickedEventClick(BaseModel):
@@ -60,6 +61,38 @@ class LinkClickedEventClick(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 LinkClickedEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
@@ -871,8 +904,6 @@ class LinkClickedEventLinkTypedDict(TypedDict):
     geo: Nullable[LinkClickedEventGeoTypedDict]
     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]
@@ -903,18 +934,22 @@ class LinkClickedEventLinkTypedDict(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[LinkClickedEventTestVariantsTypedDict]]]
     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 LinkClickedEventLink(BaseModel):
@@ -981,15 +1016,6 @@ class LinkClickedEventLink(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."""
 
@@ -1038,6 +1064,15 @@ class LinkClickedEventLink(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(
@@ -1045,7 +1080,7 @@ class LinkClickedEventLink(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[LinkClickedEventTestVariants]],
@@ -1057,17 +1092,27 @@ class LinkClickedEventLink(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",
@@ -1082,7 +1127,6 @@ class LinkClickedEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1095,6 +1139,7 @@ class LinkClickedEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/components/linkschema.py

@@ -820,8 +820,6 @@ class LinkSchemaTypedDict(TypedDict):
     r"""The Android destination URL for the short link for Android device targeting."""
     geo: Nullable[GeoTypedDict]
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
-    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]
@@ -854,8 +852,10 @@ class LinkSchemaTypedDict(TypedDict):
     r"""The date and time when the short link was created."""
     updated_at: str
     r"""The date and time when the short link was last updated."""
+    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."""
     track_conversion: NotRequired[bool]
     r"""Whether to track conversions for the short link."""
     archived: NotRequired[bool]
@@ -877,11 +877,13 @@ class LinkSchemaTypedDict(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."""
+    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 LinkSchema(BaseModel):
@@ -939,15 +941,6 @@ class LinkSchema(BaseModel):
     geo: Nullable[Geo]
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
 
-    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."""
 
@@ -996,6 +989,15 @@ class LinkSchema(BaseModel):
     updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
     r"""The date and time when the short link was last updated."""
 
+    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(
@@ -1003,7 +1005,7 @@ class LinkSchema(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."""
 
     track_conversion: Annotated[
         Optional[bool], pydantic.Field(alias="trackConversion")
@@ -1044,13 +1046,16 @@ class LinkSchema(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):
@@ -1066,6 +1071,7 @@ class LinkSchema(BaseModel):
             "testCompletedAt",
             "clicks",
             "leads",
+            "conversions",
             "sales",
             "saleAmount",
         ]
@@ -1084,7 +1090,6 @@ class LinkSchema(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1098,6 +1103,7 @@ class LinkSchema(BaseModel):
             "testCompletedAt",
             "userId",
             "lastClicked",
+            "tagId",
         ]
         null_default_fields = []