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

dub/models/operations/createpartner.py

@@ -704,6 +704,17 @@ class CreatePartnerLink(BaseModel):
     r"""The total dollar amount of sales the short links has generated (in cents)."""
 
 
+class BannedReason(str, Enum):
+    r"""If the partner was banned from the program, this is the reason for the ban."""
+
+    TOS_VIOLATION = "tos_violation"
+    INAPPROPRIATE_CONTENT = "inappropriate_content"
+    FAKE_TRAFFIC = "fake_traffic"
+    FRAUD = "fraud"
+    SPAM = "spam"
+    BRAND_ABUSE = "brand_abuse"
+
+
 class CreatePartnerResponseBodyTypedDict(TypedDict):
     r"""The created partner"""
 
@@ -717,50 +728,68 @@ class CreatePartnerResponseBodyTypedDict(TypedDict):
     r"""The partner's avatar image."""
     country: Nullable[str]
     r"""The partner's country (required for tax purposes)."""
-    website: Nullable[str]
-    r"""The partner's website URL (including the https protocol)."""
-    youtube: Nullable[str]
-    r"""The partner's YouTube channel username (e.g. `johndoe`)."""
-    twitter: Nullable[str]
-    r"""The partner's Twitter username (e.g. `johndoe`)."""
-    linkedin: Nullable[str]
-    r"""The partner's LinkedIn username (e.g. `johndoe`)."""
-    instagram: Nullable[str]
-    r"""The partner's Instagram username (e.g. `johndoe`)."""
-    tiktok: Nullable[str]
-    r"""The partner's TikTok username (e.g. `johndoe`)."""
     paypal_email: Nullable[str]
     r"""The partner's PayPal email (for receiving payouts via PayPal)."""
     stripe_connect_id: Nullable[str]
     r"""The partner's Stripe Connect ID (for receiving payouts via Stripe)."""
     payouts_enabled_at: Nullable[str]
     r"""The date when the partner enabled payouts."""
+    partner_id: str
+    r"""The partner's unique ID on Dub."""
+    tenant_id: Nullable[str]
+    r"""The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future."""
+    program_id: str
+    r"""The program's unique ID on Dub."""
     created_at: str
-    r"""The date when the partner was created on Dub."""
     status: CreatePartnerStatus
     r"""The status of the partner's enrollment in the program."""
-    program_id: str
-    r"""The program's unique ID on Dub."""
-    tenant_id: Nullable[str]
-    r"""The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future."""
     links: Nullable[List[CreatePartnerLinkTypedDict]]
     r"""The partner's referral links in this program."""
     description: NotRequired[Nullable[str]]
     r"""A brief description of the partner and their background."""
+    total_commissions: NotRequired[float]
+    r"""The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false."""
+    click_reward_id: NotRequired[Nullable[str]]
+    lead_reward_id: NotRequired[Nullable[str]]
+    sale_reward_id: NotRequired[Nullable[str]]
+    discount_id: NotRequired[Nullable[str]]
+    application_id: NotRequired[Nullable[str]]
+    r"""If the partner submitted an application to join the program, this is the ID of the application."""
+    banned_at: NotRequired[Nullable[str]]
+    r"""If the partner was banned from the program, this is the date of the ban."""
+    banned_reason: NotRequired[Nullable[BannedReason]]
+    r"""If the partner was banned from the program, this is the reason for the ban."""
     clicks: NotRequired[float]
-    r"""The total number of clicks on the partner's links."""
+    r"""The total number of clicks on the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
     leads: NotRequired[float]
-    r"""The total number of leads generated by the partner's links."""
+    r"""The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
     sales: NotRequired[float]
-    r"""The total number of sales generated by the partner's links."""
+    r"""The total number of sales generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
     sale_amount: NotRequired[float]
-    r"""The total amount of sales (in cents) generated by the partner's links."""
-    total_commissions: NotRequired[float]
-    r"""The total commissions paid to the partner for their referrals."""
+    r"""The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
     net_revenue: NotRequired[float]
-    r"""The total net revenue generated by the partner."""
-    earnings: NotRequired[float]
-    r"""DEPRECATED: The total earnings/commissions accrued by the partner's links."""
+    r"""The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false."""
+    website: NotRequired[Nullable[str]]
+    r"""The partner's website URL (including the https protocol)."""
+    website_txt_record: NotRequired[Nullable[str]]
+    website_verified_at: NotRequired[Nullable[str]]
+    youtube: NotRequired[Nullable[str]]
+    r"""The partner's YouTube channel username (e.g. `johndoe`)."""
+    youtube_verified_at: NotRequired[Nullable[str]]
+    youtube_subscriber_count: NotRequired[Nullable[float]]
+    youtube_view_count: NotRequired[Nullable[float]]
+    twitter: NotRequired[Nullable[str]]
+    r"""The partner's Twitter username (e.g. `johndoe`)."""
+    twitter_verified_at: NotRequired[Nullable[str]]
+    linkedin: NotRequired[Nullable[str]]
+    r"""The partner's LinkedIn username (e.g. `johndoe`)."""
+    linkedin_verified_at: NotRequired[Nullable[str]]
+    instagram: NotRequired[Nullable[str]]
+    r"""The partner's Instagram username (e.g. `johndoe`)."""
+    instagram_verified_at: NotRequired[Nullable[str]]
+    tiktok: NotRequired[Nullable[str]]
+    r"""The partner's TikTok username (e.g. `johndoe`)."""
+    tiktok_verified_at: NotRequired[Nullable[str]]
 
 
 class CreatePartnerResponseBody(BaseModel):
@@ -781,24 +810,6 @@ class CreatePartnerResponseBody(BaseModel):
     country: Nullable[str]
     r"""The partner's country (required for tax purposes)."""
 
-    website: Nullable[str]
-    r"""The partner's website URL (including the https protocol)."""
-
-    youtube: Nullable[str]
-    r"""The partner's YouTube channel username (e.g. `johndoe`)."""
-
-    twitter: Nullable[str]
-    r"""The partner's Twitter username (e.g. `johndoe`)."""
-
-    linkedin: Nullable[str]
-    r"""The partner's LinkedIn username (e.g. `johndoe`)."""
-
-    instagram: Nullable[str]
-    r"""The partner's Instagram username (e.g. `johndoe`)."""
-
-    tiktok: Nullable[str]
-    r"""The partner's TikTok username (e.g. `johndoe`)."""
-
     paypal_email: Annotated[Nullable[str], pydantic.Field(alias="paypalEmail")]
     r"""The partner's PayPal email (for receiving payouts via PayPal)."""
 
@@ -810,17 +821,19 @@ class CreatePartnerResponseBody(BaseModel):
     ]
     r"""The date when the partner enabled payouts."""
 
-    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
-    r"""The date when the partner was created on Dub."""
+    partner_id: Annotated[str, pydantic.Field(alias="partnerId")]
+    r"""The partner's unique ID on Dub."""
 
-    status: CreatePartnerStatus
-    r"""The status of the partner's enrollment in the program."""
+    tenant_id: Annotated[Nullable[str], pydantic.Field(alias="tenantId")]
+    r"""The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future."""
 
     program_id: Annotated[str, pydantic.Field(alias="programId")]
     r"""The program's unique ID on Dub."""
 
-    tenant_id: Annotated[Nullable[str], pydantic.Field(alias="tenantId")]
-    r"""The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future."""
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+
+    status: CreatePartnerStatus
+    r"""The status of the partner's enrollment in the program."""
 
     links: Nullable[List[CreatePartnerLink]]
     r"""The partner's referral links in this program."""
@@ -828,62 +841,176 @@ class CreatePartnerResponseBody(BaseModel):
     description: OptionalNullable[str] = UNSET
     r"""A brief description of the partner and their background."""
 
+    total_commissions: Annotated[
+        Optional[float], pydantic.Field(alias="totalCommissions")
+    ] = 0
+    r"""The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false."""
+
+    click_reward_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="clickRewardId")
+    ] = UNSET
+
+    lead_reward_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="leadRewardId")
+    ] = UNSET
+
+    sale_reward_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="saleRewardId")
+    ] = UNSET
+
+    discount_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="discountId")
+    ] = UNSET
+
+    application_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="applicationId")
+    ] = UNSET
+    r"""If the partner submitted an application to join the program, this is the ID of the application."""
+
+    banned_at: Annotated[OptionalNullable[str], pydantic.Field(alias="bannedAt")] = (
+        UNSET
+    )
+    r"""If the partner was banned from the program, this is the date of the ban."""
+
+    banned_reason: Annotated[
+        OptionalNullable[BannedReason], pydantic.Field(alias="bannedReason")
+    ] = UNSET
+    r"""If the partner was banned from the program, this is the reason for the ban."""
+
     clicks: Optional[float] = 0
-    r"""The total number of clicks on the partner's links."""
+    r"""The total number of clicks on the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
 
     leads: Optional[float] = 0
-    r"""The total number of leads generated by the partner's links."""
+    r"""The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
 
     sales: Optional[float] = 0
-    r"""The total number of sales generated by the partner's links."""
+    r"""The total number of sales generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total amount of sales (in cents) generated by the partner's links."""
-
-    total_commissions: Annotated[
-        Optional[float], pydantic.Field(alias="totalCommissions")
-    ] = 0
-    r"""The total commissions paid to the partner for their referrals."""
+    r"""The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
 
     net_revenue: Annotated[Optional[float], pydantic.Field(alias="netRevenue")] = 0
-    r"""The total net revenue generated by the partner."""
+    r"""The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false."""
 
-    earnings: Annotated[
-        Optional[float],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
-        ),
-    ] = 0
-    r"""DEPRECATED: The total earnings/commissions accrued by the partner's links."""
+    website: OptionalNullable[str] = UNSET
+    r"""The partner's website URL (including the https protocol)."""
+
+    website_txt_record: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="websiteTxtRecord")
+    ] = UNSET
+
+    website_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="websiteVerifiedAt")
+    ] = UNSET
+
+    youtube: OptionalNullable[str] = UNSET
+    r"""The partner's YouTube channel username (e.g. `johndoe`)."""
+
+    youtube_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="youtubeVerifiedAt")
+    ] = UNSET
+
+    youtube_subscriber_count: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="youtubeSubscriberCount")
+    ] = UNSET
+
+    youtube_view_count: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="youtubeViewCount")
+    ] = UNSET
+
+    twitter: OptionalNullable[str] = UNSET
+    r"""The partner's Twitter username (e.g. `johndoe`)."""
+
+    twitter_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="twitterVerifiedAt")
+    ] = UNSET
+
+    linkedin: OptionalNullable[str] = UNSET
+    r"""The partner's LinkedIn username (e.g. `johndoe`)."""
+
+    linkedin_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="linkedinVerifiedAt")
+    ] = UNSET
+
+    instagram: OptionalNullable[str] = UNSET
+    r"""The partner's Instagram username (e.g. `johndoe`)."""
+
+    instagram_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="instagramVerifiedAt")
+    ] = UNSET
+
+    tiktok: OptionalNullable[str] = UNSET
+    r"""The partner's TikTok username (e.g. `johndoe`)."""
+
+    tiktok_verified_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="tiktokVerifiedAt")
+    ] = UNSET
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
             "description",
+            "totalCommissions",
+            "clickRewardId",
+            "leadRewardId",
+            "saleRewardId",
+            "discountId",
+            "applicationId",
+            "bannedAt",
+            "bannedReason",
             "clicks",
             "leads",
             "sales",
             "saleAmount",
-            "totalCommissions",
             "netRevenue",
-            "earnings",
+            "website",
+            "websiteTxtRecord",
+            "websiteVerifiedAt",
+            "youtube",
+            "youtubeVerifiedAt",
+            "youtubeSubscriberCount",
+            "youtubeViewCount",
+            "twitter",
+            "twitterVerifiedAt",
+            "linkedin",
+            "linkedinVerifiedAt",
+            "instagram",
+            "instagramVerifiedAt",
+            "tiktok",
+            "tiktokVerifiedAt",
         ]
         nullable_fields = [
             "email",
             "image",
             "description",
             "country",
+            "paypalEmail",
+            "stripeConnectId",
+            "payoutsEnabledAt",
+            "tenantId",
+            "links",
+            "clickRewardId",
+            "leadRewardId",
+            "saleRewardId",
+            "discountId",
+            "applicationId",
+            "bannedAt",
+            "bannedReason",
             "website",
+            "websiteTxtRecord",
+            "websiteVerifiedAt",
             "youtube",
+            "youtubeVerifiedAt",
+            "youtubeSubscriberCount",
+            "youtubeViewCount",
             "twitter",
+            "twitterVerifiedAt",
             "linkedin",
+            "linkedinVerifiedAt",
             "instagram",
+            "instagramVerifiedAt",
             "tiktok",
-            "paypalEmail",
-            "stripeConnectId",
-            "payoutsEnabledAt",
-            "tenantId",
-            "links",
+            "tiktokVerifiedAt",
         ]
         null_default_fields = []
 

dub/models/operations/listcommissions.py

@@ -188,6 +188,155 @@ class ListCommissionsStatus(str, Enum):
     CANCELED = "canceled"
 
 
+class ListCommissionsPartnerTypedDict(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 ListCommissionsPartner(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 ListCommissionsCustomerTypedDict(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 ListCommissionsCustomer(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 ListCommissionsResponseBodyTypedDict(TypedDict):
     id: str
     r"""The commission's unique ID on Dub."""
@@ -195,11 +344,16 @@ class ListCommissionsResponseBodyTypedDict(TypedDict):
     earnings: float
     currency: str
     status: ListCommissionsStatus
+    invoice_id: Nullable[str]
+    description: Nullable[str]
+    quantity: float
     created_at: str
     updated_at: str
+    partner: ListCommissionsPartnerTypedDict
     type: NotRequired[ListCommissionsType]
-    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[ListCommissionsCustomerTypedDict]]
 
 
 class ListCommissionsResponseBody(BaseModel):
@@ -214,22 +368,29 @@ class ListCommissionsResponseBody(BaseModel):
 
     status: ListCommissionsStatus
 
+    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: ListCommissionsPartner
+
     type: Optional[ListCommissionsType] = 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[ListCommissionsCustomer] = 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/listevents.py

@@ -50,6 +50,8 @@ class QueryParamTrigger(str, Enum):
 
     QR = "qr"
     LINK = "link"
+    PAGEVIEW = "pageview"
+    DEEPLINK = "deeplink"
 
 
 ListEventsQueryParamTagIdsTypedDict = TypeAliasType(
@@ -64,6 +66,13 @@ ListEventsQueryParamTagIds = TypeAliasType(
 r"""The tag IDs to retrieve analytics for."""
 
 
+class QueryParamSaleType(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 QueryParamSortOrder(str, Enum):
     r"""The sort order. The default is `desc`."""
 
@@ -146,6 +155,8 @@ class ListEventsRequestTypedDict(TypedDict):
     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."""
     utm_source: NotRequired[Nullable[str]]
     r"""The UTM source of the short link."""
     utm_medium: NotRequired[Nullable[str]]
@@ -351,6 +362,13 @@ class ListEventsRequest(BaseModel):
     ] = None
     r"""Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both."""
 
+    sale_type: Annotated[
+        Optional[QueryParamSaleType],
+        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."""
+
     utm_source: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -443,6 +461,7 @@ class ListEventsRequest(BaseModel):
             "folderId",
             "qr",
             "root",
+            "saleType",
             "utm_source",
             "utm_medium",
             "utm_campaign",