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

dub/models/operations/retrieveanalytics.py

@@ -78,10 +78,12 @@ 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"
+    PAGEVIEW = "pageview"
+    DEEPLINK = "deeplink"
 
 
 RetrieveAnalyticsQueryParamTagIdsTypedDict = TypeAliasType(
@@ -96,6 +98,13 @@ RetrieveAnalyticsQueryParamTagIds = TypeAliasType(
 r"""The tag IDs to retrieve analytics for."""
 
 
+class SaleType(str, Enum):
+    r"""Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both."""
+
+    NEW = "new"
+    RECURRING = "recurring"
+
+
 class RetrieveAnalyticsRequestTypedDict(TypedDict):
     event: NotRequired[Event]
     r"""The type of event to retrieve analytics for. Defaults to `clicks`."""
@@ -140,23 +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]]
@@ -307,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],
@@ -328,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"),
@@ -349,17 +355,37 @@ class RetrieveAnalyticsRequest(BaseModel):
     ] = None
     r"""The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links."""
 
-    qr: Annotated[
+    root: 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."""
+    r"""Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."""
 
-    root: Annotated[
+    sale_type: Annotated[
+        Optional[SaleType],
+        pydantic.Field(alias="saleType"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 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"""Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."""
+    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],
@@ -419,11 +445,13 @@ class RetrieveAnalyticsRequest(BaseModel):
             "referer",
             "refererUrl",
             "url",
-            "tagId",
             "tagIds",
             "folderId",
-            "qr",
             "root",
+            "saleType",
+            "query",
+            "tagId",
+            "qr",
             "utm_source",
             "utm_medium",
             "utm_campaign",

dub/models/operations/retrievelinks.py

@@ -41,11 +41,11 @@ class LinkTypedDict(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 Link(BaseModel):
@@ -68,10 +68,10 @@ class Link(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."""

dub/models/operations/tracksale.py

@@ -16,6 +16,7 @@ class PaymentProcessor(str, Enum):
     SHOPIFY = "shopify"
     POLAR = "polar"
     PADDLE = "paddle"
+    REVENUECAT = "revenuecat"
     CUSTOM = "custom"
 
 

dub/models/operations/updatecommission.py

@@ -81,6 +81,155 @@ class UpdateCommissionStatus(str, Enum):
     CANCELED = "canceled"
 
 
+class UpdateCommissionPartnerTypedDict(TypedDict):
+    id: str
+    r"""The partner's unique ID on Dub."""
+    name: str
+    r"""The partner's full legal name."""
+    email: Nullable[str]
+    r"""The partner's email address. Should be a unique value across Dub."""
+    image: Nullable[str]
+    r"""The partner's avatar image."""
+    payouts_enabled_at: Nullable[str]
+    r"""The date when the partner enabled payouts."""
+    country: Nullable[str]
+    r"""The partner's country (required for tax purposes)."""
+
+
+class UpdateCommissionPartner(BaseModel):
+    id: str
+    r"""The partner's unique ID on Dub."""
+
+    name: str
+    r"""The partner's full legal name."""
+
+    email: Nullable[str]
+    r"""The partner's email address. Should be a unique value across Dub."""
+
+    image: Nullable[str]
+    r"""The partner's avatar image."""
+
+    payouts_enabled_at: Annotated[
+        Nullable[str], pydantic.Field(alias="payoutsEnabledAt")
+    ]
+    r"""The date when the partner enabled payouts."""
+
+    country: Nullable[str]
+    r"""The partner's country (required for tax purposes)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["email", "image", "payoutsEnabledAt", "country"]
+        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 UpdateCommissionCustomerTypedDict(TypedDict):
+    id: str
+    r"""The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`)."""
+    external_id: str
+    r"""Unique identifier for the customer in the client's app."""
+    name: str
+    r"""Name of the customer."""
+    created_at: str
+    r"""The date the customer was created."""
+    email: NotRequired[Nullable[str]]
+    r"""Email of the customer."""
+    avatar: NotRequired[Nullable[str]]
+    r"""Avatar URL of the customer."""
+    country: NotRequired[Nullable[str]]
+    r"""Country of the customer."""
+    sales: NotRequired[Nullable[float]]
+    r"""Total number of sales for the customer."""
+    sale_amount: NotRequired[Nullable[float]]
+    r"""Total amount of sales for the customer."""
+
+
+class UpdateCommissionCustomer(BaseModel):
+    id: str
+    r"""The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`)."""
+
+    external_id: Annotated[str, pydantic.Field(alias="externalId")]
+    r"""Unique identifier for the customer in the client's app."""
+
+    name: str
+    r"""Name of the customer."""
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The date the customer was created."""
+
+    email: OptionalNullable[str] = UNSET
+    r"""Email of the customer."""
+
+    avatar: OptionalNullable[str] = UNSET
+    r"""Avatar URL of the customer."""
+
+    country: OptionalNullable[str] = UNSET
+    r"""Country of the customer."""
+
+    sales: OptionalNullable[float] = UNSET
+    r"""Total number of sales for the customer."""
+
+    sale_amount: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="saleAmount")
+    ] = UNSET
+    r"""Total amount of sales for the customer."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["email", "avatar", "country", "sales", "saleAmount"]
+        nullable_fields = ["email", "avatar", "country", "sales", "saleAmount"]
+        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 UpdateCommissionResponseBodyTypedDict(TypedDict):
     r"""The updated commission."""
 
@@ -90,11 +239,16 @@ class UpdateCommissionResponseBodyTypedDict(TypedDict):
     earnings: float
     currency: str
     status: UpdateCommissionStatus
+    invoice_id: Nullable[str]
+    description: Nullable[str]
+    quantity: float
     created_at: str
     updated_at: str
+    partner: UpdateCommissionPartnerTypedDict
     type: NotRequired[UpdateCommissionType]
-    invoice_id: NotRequired[Nullable[str]]
-    description: NotRequired[Nullable[str]]
+    user_id: NotRequired[Nullable[str]]
+    r"""The user who created the manual commission."""
+    customer: NotRequired[Nullable[UpdateCommissionCustomerTypedDict]]
 
 
 class UpdateCommissionResponseBody(BaseModel):
@@ -111,22 +265,29 @@ class UpdateCommissionResponseBody(BaseModel):
 
     status: UpdateCommissionStatus
 
+    invoice_id: Annotated[Nullable[str], pydantic.Field(alias="invoiceId")]
+
+    description: Nullable[str]
+
+    quantity: float
+
     created_at: Annotated[str, pydantic.Field(alias="createdAt")]
 
     updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
 
+    partner: UpdateCommissionPartner
+
     type: Optional[UpdateCommissionType] = None
 
-    invoice_id: Annotated[OptionalNullable[str], pydantic.Field(alias="invoiceId")] = (
-        UNSET
-    )
+    user_id: Annotated[OptionalNullable[str], pydantic.Field(alias="userId")] = UNSET
+    r"""The user who created the manual commission."""
 
-    description: OptionalNullable[str] = UNSET
+    customer: OptionalNullable[UpdateCommissionCustomer] = UNSET
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["type", "invoiceId", "description"]
-        nullable_fields = ["invoiceId", "description"]
+        optional_fields = ["type", "userId", "customer"]
+        nullable_fields = ["invoiceId", "description", "userId", "customer"]
         null_default_fields = []
 
         serialized = handler(self)

dub/models/operations/updatelink.py

@@ -60,10 +60,6 @@ class UpdateLinkRequestBodyTypedDict(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[UpdateLinkTagIdsTypedDict]
     r"""The unique IDs of the tags assigned to the short link."""
     tag_names: NotRequired[UpdateLinkTagNamesTypedDict]
@@ -117,6 +113,10 @@ class UpdateLinkRequestBodyTypedDict(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 UpdateLinkRequestBody(BaseModel):
@@ -157,24 +157,6 @@ class UpdateLinkRequestBody(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[UpdateLinkTagIds], pydantic.Field(alias="tagIds")] = (
         None
     )
@@ -274,6 +256,24 @@ class UpdateLinkRequestBody(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 = [
@@ -286,8 +286,6 @@ class UpdateLinkRequestBody(BaseModel):
             "partnerId",
             "trackConversion",
             "archived",
-            "publicStats",
-            "tagId",
             "tagIds",
             "tagNames",
             "folderId",
@@ -315,13 +313,14 @@ class UpdateLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "publicStats",
+            "tagId",
         ]
         nullable_fields = [
             "externalId",
             "tenantId",
             "programId",
             "partnerId",
-            "tagId",
             "folderId",
             "comments",
             "expiresAt",
@@ -344,6 +343,7 @@ class UpdateLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/operations/upsertlink.py

@@ -63,10 +63,6 @@ class UpsertLinkRequestBodyTypedDict(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[UpsertLinkTagIdsTypedDict]
     r"""The unique IDs of the tags assigned to the short link."""
     tag_names: NotRequired[UpsertLinkTagNamesTypedDict]
@@ -121,6 +117,10 @@ class UpsertLinkRequestBodyTypedDict(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 UpsertLinkRequestBody(BaseModel):
@@ -167,24 +167,6 @@ class UpsertLinkRequestBody(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[UpsertLinkTagIds], pydantic.Field(alias="tagIds")] = (
         None
     )
@@ -285,6 +267,24 @@ class UpsertLinkRequestBody(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 = [
@@ -298,8 +298,6 @@ class UpsertLinkRequestBody(BaseModel):
             "prefix",
             "trackConversion",
             "archived",
-            "publicStats",
-            "tagId",
             "tagIds",
             "tagNames",
             "folderId",
@@ -327,13 +325,14 @@ class UpsertLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "publicStats",
+            "tagId",
         ]
         nullable_fields = [
             "externalId",
             "tenantId",
             "programId",
             "partnerId",
-            "tagId",
             "folderId",
             "comments",
             "expiresAt",
@@ -356,6 +355,7 @@ class UpsertLinkRequestBody(BaseModel):
             "testVariants",
             "testStartedAt",
             "testCompletedAt",
+            "tagId",
         ]
         null_default_fields = []