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

dub/models/operations/bulkcreatelinks.py

@@ -69,10 +69,6 @@ class RequestBodyTypedDict(TypedDict):
     r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
     archived: NotRequired[bool]
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
-    public_stats: NotRequired[bool]
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-    tag_id: NotRequired[Nullable[str]]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
     tag_ids: NotRequired[BulkCreateLinksTagIdsTypedDict]
     r"""The unique IDs of the tags assigned to the short link."""
     tag_names: NotRequired[BulkCreateLinksTagNamesTypedDict]
@@ -127,6 +123,10 @@ class RequestBodyTypedDict(TypedDict):
     r"""The date and time when the tests started."""
     test_completed_at: NotRequired[Nullable[str]]
     r"""The date and time when the tests were or will be completed."""
+    public_stats: NotRequired[bool]
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+    tag_id: NotRequired[Nullable[str]]
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
 
 
 class RequestBody(BaseModel):
@@ -173,24 +173,6 @@ class RequestBody(BaseModel):
     archived: Optional[bool] = None
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
 
-    public_stats: Annotated[
-        Optional[bool],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="publicStats",
-        ),
-    ] = None
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-
-    tag_id: Annotated[
-        OptionalNullable[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",
-        ),
-    ] = UNSET
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
-
     tag_ids: Annotated[
         Optional[BulkCreateLinksTagIds], pydantic.Field(alias="tagIds")
     ] = None
@@ -291,6 +273,24 @@ class RequestBody(BaseModel):
     ] = UNSET
     r"""The date and time when the tests were or will be completed."""
 
+    public_stats: Annotated[
+        Optional[bool],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="publicStats",
+        ),
+    ] = None
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+
+    tag_id: Annotated[
+        OptionalNullable[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",
+        ),
+    ] = UNSET
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -304,8 +304,6 @@ class RequestBody(BaseModel):
             "prefix",
             "trackConversion",
             "archived",
-            "publicStats",
-            "tagId",
             "tagIds",
             "tagNames",
             "folderId",
@@ -333,13 +331,14 @@ class RequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "publicStats",
+            "tagId",
         ]
         nullable_fields = [
             "externalId",
             "tenantId",
             "programId",
             "partnerId",
-            "tagId",
             "folderId",
             "comments",
             "expiresAt",
@@ -362,6 +361,7 @@ class RequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/operations/bulkupdatelinks.py

@@ -55,10 +55,6 @@ class DataTypedDict(TypedDict):
     r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
     archived: NotRequired[bool]
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
-    public_stats: NotRequired[bool]
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-    tag_id: NotRequired[Nullable[str]]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
     tag_ids: NotRequired[BulkUpdateLinksTagIdsTypedDict]
     r"""The unique IDs of the tags assigned to the short link."""
     tag_names: NotRequired[BulkUpdateLinksTagNamesTypedDict]
@@ -113,6 +109,10 @@ class DataTypedDict(TypedDict):
     r"""The date and time when the tests started."""
     test_completed_at: NotRequired[Nullable[str]]
     r"""The date and time when the tests were or will be completed."""
+    public_stats: NotRequired[bool]
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+    tag_id: NotRequired[Nullable[str]]
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
 
 
 class Data(BaseModel):
@@ -142,24 +142,6 @@ class Data(BaseModel):
     archived: Optional[bool] = None
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
 
-    public_stats: Annotated[
-        Optional[bool],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="publicStats",
-        ),
-    ] = None
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-
-    tag_id: Annotated[
-        OptionalNullable[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",
-        ),
-    ] = UNSET
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
-
     tag_ids: Annotated[
         Optional[BulkUpdateLinksTagIds], pydantic.Field(alias="tagIds")
     ] = None
@@ -260,6 +242,24 @@ class Data(BaseModel):
     ] = UNSET
     r"""The date and time when the tests were or will be completed."""
 
+    public_stats: Annotated[
+        Optional[bool],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="publicStats",
+        ),
+    ] = None
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+
+    tag_id: Annotated[
+        OptionalNullable[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",
+        ),
+    ] = UNSET
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -269,8 +269,6 @@ class Data(BaseModel):
             "partnerId",
             "trackConversion",
             "archived",
-            "publicStats",
-            "tagId",
             "tagIds",
             "tagNames",
             "folderId",
@@ -298,12 +296,13 @@ class Data(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "publicStats",
+            "tagId",
         ]
         nullable_fields = [
             "tenantId",
             "programId",
             "partnerId",
-            "tagId",
             "folderId",
             "comments",
             "expiresAt",
@@ -326,6 +325,7 @@ class Data(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/operations/createlink.py

@@ -63,10 +63,6 @@ class CreateLinkRequestBodyTypedDict(TypedDict):
     r"""Whether to track conversions for the short link. Defaults to `false` if not provided."""
     archived: NotRequired[bool]
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
-    public_stats: NotRequired[bool]
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-    tag_id: NotRequired[Nullable[str]]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
     tag_ids: NotRequired[TagIdsTypedDict]
     r"""The unique IDs of the tags assigned to the short link."""
     tag_names: NotRequired[TagNamesTypedDict]
@@ -121,6 +117,10 @@ class CreateLinkRequestBodyTypedDict(TypedDict):
     r"""The date and time when the tests started."""
     test_completed_at: NotRequired[Nullable[str]]
     r"""The date and time when the tests were or will be completed."""
+    public_stats: NotRequired[bool]
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+    tag_id: NotRequired[Nullable[str]]
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
 
 
 class CreateLinkRequestBody(BaseModel):
@@ -167,24 +167,6 @@ class CreateLinkRequestBody(BaseModel):
     archived: Optional[bool] = None
     r"""Whether the short link is archived. Defaults to `false` if not provided."""
 
-    public_stats: Annotated[
-        Optional[bool],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="publicStats",
-        ),
-    ] = None
-    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
-
-    tag_id: Annotated[
-        OptionalNullable[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",
-        ),
-    ] = UNSET
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead."""
-
     tag_ids: Annotated[Optional[TagIds], pydantic.Field(alias="tagIds")] = None
     r"""The unique IDs of the tags assigned to the short link."""
 
@@ -280,6 +262,24 @@ class CreateLinkRequestBody(BaseModel):
     ] = UNSET
     r"""The date and time when the tests were or will be completed."""
 
+    public_stats: Annotated[
+        Optional[bool],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="publicStats",
+        ),
+    ] = None
+    r"""Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided."""
+
+    tag_id: Annotated[
+        OptionalNullable[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",
+        ),
+    ] = UNSET
+    r"""Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -293,8 +293,6 @@ class CreateLinkRequestBody(BaseModel):
             "prefix",
             "trackConversion",
             "archived",
-            "publicStats",
-            "tagId",
             "tagIds",
             "tagNames",
             "folderId",
@@ -322,13 +320,14 @@ class CreateLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "publicStats",
+            "tagId",
         ]
         nullable_fields = [
             "externalId",
             "tenantId",
             "programId",
             "partnerId",
-            "tagId",
             "folderId",
             "comments",
             "expiresAt",
@@ -351,6 +350,7 @@ class CreateLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/operations/createpartner.py

@@ -668,11 +668,11 @@ class CreatePartnerLinkTypedDict(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 CreatePartnerLink(BaseModel):
@@ -695,13 +695,13 @@ class CreatePartnerLink(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/operations/getlinks.py

@@ -68,7 +68,7 @@ class GetLinksRequestTypedDict(TypedDict):
     domain: NotRequired[str]
     r"""The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned."""
     tag_id: NotRequired[str]
-    r"""Deprecated. Use `tagIds` instead. The tag ID to filter the links by."""
+    r"""Deprecated: Use `tagIds` instead. The tag ID to filter the links by."""
     tag_ids: NotRequired[QueryParamTagIdsTypedDict]
     r"""The tag IDs to filter the links by."""
     tag_names: NotRequired[QueryParamTagNamesTypedDict]
@@ -109,7 +109,7 @@ class GetLinksRequest(BaseModel):
         pydantic.Field(alias="tagId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Deprecated. Use `tagIds` instead. The tag ID to filter the links by."""
+    r"""Deprecated: Use `tagIds` instead. The tag ID to filter the links by."""
 
     tag_ids: Annotated[
         Optional[QueryParamTagIds],

dub/models/operations/getlinkscount.py

@@ -61,7 +61,7 @@ class GetLinksCountRequestTypedDict(TypedDict):
     domain: NotRequired[str]
     r"""The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned."""
     tag_id: NotRequired[str]
-    r"""Deprecated. Use `tagIds` instead. The tag ID to filter the links by."""
+    r"""Deprecated: Use `tagIds` instead. The tag ID to filter the links by."""
     tag_ids: NotRequired[GetLinksCountQueryParamTagIdsTypedDict]
     r"""The tag IDs to filter the links by."""
     tag_names: NotRequired[GetLinksCountQueryParamTagNamesTypedDict]
@@ -94,7 +94,7 @@ class GetLinksCountRequest(BaseModel):
         pydantic.Field(alias="tagId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Deprecated. Use `tagIds` instead. The tag ID to filter the links by."""
+    r"""Deprecated: Use `tagIds` instead. The tag ID to filter the links by."""
 
     tag_ids: Annotated[
         Optional[GetLinksCountQueryParamTagIds],

dub/models/operations/listevents.py

@@ -46,7 +46,7 @@ class QueryParamInterval(str, Enum):
 
 
 class QueryParamTrigger(str, Enum):
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
 
     QR = "qr"
     LINK = "link"
@@ -138,25 +138,27 @@ class ListEventsRequestTypedDict(TypedDict):
     os: NotRequired[str]
     r"""The OS to retrieve analytics for."""
     trigger: NotRequired[QueryParamTrigger]
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
     referer: NotRequired[str]
     r"""The referer to retrieve analytics for."""
     referer_url: NotRequired[str]
     r"""The full referer URL to retrieve analytics for."""
     url: NotRequired[str]
     r"""The URL to retrieve analytics for."""
-    tag_id: NotRequired[str]
-    r"""Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for."""
     tag_ids: NotRequired[ListEventsQueryParamTagIdsTypedDict]
     r"""The tag IDs to retrieve analytics for."""
     folder_id: NotRequired[str]
     r"""The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links."""
-    qr: NotRequired[bool]
-    r"""Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
     root: NotRequired[bool]
     r"""Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."""
     sale_type: NotRequired[QueryParamSaleType]
     r"""Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both."""
+    query: NotRequired[str]
+    r"""Search the events by a custom metadata value. Only available for lead and sale events."""
+    tag_id: NotRequired[str]
+    r"""Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for."""
+    qr: NotRequired[bool]
+    r"""Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
     utm_source: NotRequired[Nullable[str]]
     r"""The UTM source of the short link."""
     utm_medium: NotRequired[Nullable[str]]
@@ -308,7 +310,7 @@ class ListEventsRequest(BaseModel):
         Optional[QueryParamTrigger],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
 
     referer: Annotated[
         Optional[str],
@@ -329,13 +331,6 @@ class ListEventsRequest(BaseModel):
     ] = None
     r"""The URL to retrieve analytics for."""
 
-    tag_id: Annotated[
-        Optional[str],
-        pydantic.Field(alias="tagId"),
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for."""
-
     tag_ids: Annotated[
         Optional[ListEventsQueryParamTagIds],
         pydantic.Field(alias="tagIds"),
@@ -350,12 +345,6 @@ class ListEventsRequest(BaseModel):
     ] = None
     r"""The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links."""
 
-    qr: Annotated[
-        Optional[bool],
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
-
     root: Annotated[
         Optional[bool],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -369,6 +358,25 @@ class ListEventsRequest(BaseModel):
     ] = None
     r"""Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both."""
 
+    query: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Search the events by a custom metadata value. Only available for lead and sale events."""
+
+    tag_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tagId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for."""
+
+    qr: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
+
     utm_source: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -456,12 +464,13 @@ class ListEventsRequest(BaseModel):
             "referer",
             "refererUrl",
             "url",
-            "tagId",
             "tagIds",
             "folderId",
-            "qr",
             "root",
             "saleType",
+            "query",
+            "tagId",
+            "qr",
             "utm_source",
             "utm_medium",
             "utm_campaign",

dub/models/operations/listpartners.py

@@ -149,11 +149,11 @@ class ListPartnersLinkTypedDict(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 ListPartnersLink(BaseModel):
@@ -176,13 +176,13 @@ class ListPartnersLink(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 ListPartnersBannedReason(str, Enum):

dub/models/operations/retrieveanalytics.py

@@ -78,7 +78,7 @@ class Interval(str, Enum):
 
 
 class Trigger(str, Enum):
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
 
     QR = "qr"
     LINK = "link"
@@ -149,25 +149,27 @@ class RetrieveAnalyticsRequestTypedDict(TypedDict):
     os: NotRequired[str]
     r"""The OS to retrieve analytics for."""
     trigger: NotRequired[Trigger]
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
     referer: NotRequired[str]
     r"""The referer to retrieve analytics for."""
     referer_url: NotRequired[str]
     r"""The full referer URL to retrieve analytics for."""
     url: NotRequired[str]
     r"""The URL to retrieve analytics for."""
-    tag_id: NotRequired[str]
-    r"""Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for."""
     tag_ids: NotRequired[RetrieveAnalyticsQueryParamTagIdsTypedDict]
     r"""The tag IDs to retrieve analytics for."""
     folder_id: NotRequired[str]
     r"""The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links."""
-    qr: NotRequired[bool]
-    r"""Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
     root: NotRequired[bool]
     r"""Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."""
     sale_type: NotRequired[SaleType]
     r"""Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both."""
+    query: NotRequired[str]
+    r"""Search the events by a custom metadata value. Only available for lead and sale events."""
+    tag_id: NotRequired[str]
+    r"""Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for."""
+    qr: NotRequired[bool]
+    r"""Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
     utm_source: NotRequired[Nullable[str]]
     r"""The UTM source of the short link."""
     utm_medium: NotRequired[Nullable[str]]
@@ -318,7 +320,7 @@ class RetrieveAnalyticsRequest(BaseModel):
         Optional[Trigger],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""The trigger to retrieve analytics for. If undefined, return both QR and link clicks."""
+    r"""The trigger to retrieve analytics for. If undefined, returns all trigger types."""
 
     referer: Annotated[
         Optional[str],
@@ -339,13 +341,6 @@ class RetrieveAnalyticsRequest(BaseModel):
     ] = None
     r"""The URL to retrieve analytics for."""
 
-    tag_id: Annotated[
-        Optional[str],
-        pydantic.Field(alias="tagId"),
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for."""
-
     tag_ids: Annotated[
         Optional[RetrieveAnalyticsQueryParamTagIds],
         pydantic.Field(alias="tagIds"),
@@ -360,12 +355,6 @@ class RetrieveAnalyticsRequest(BaseModel):
     ] = None
     r"""The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links."""
 
-    qr: Annotated[
-        Optional[bool],
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = None
-    r"""Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
-
     root: Annotated[
         Optional[bool],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -379,6 +368,25 @@ class RetrieveAnalyticsRequest(BaseModel):
     ] = None
     r"""Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both."""
 
+    query: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Search the events by a custom metadata value. Only available for lead and sale events."""
+
+    tag_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tagId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for."""
+
+    qr: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both."""
+
     utm_source: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -437,12 +445,13 @@ class RetrieveAnalyticsRequest(BaseModel):
             "referer",
             "refererUrl",
             "url",
-            "tagId",
             "tagIds",
             "folderId",
-            "qr",
             "root",
             "saleType",
+            "query",
+            "tagId",
+            "qr",
             "utm_source",
             "utm_medium",
             "utm_campaign",