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

dub/models/components/linkwebhookevent.py

@@ -840,8 +840,6 @@ class LinkWebhookEventLinkTypedDict(TypedDict):
     geo: Nullable[LinkWebhookEventGeoTypedDict]
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
     public_stats: bool
-    tag_id: Nullable[str]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
     tags: Nullable[List[TagSchemaTypedDict]]
     r"""The tags assigned to the short link."""
     folder_id: Nullable[str]
@@ -872,18 +870,22 @@ class LinkWebhookEventLinkTypedDict(TypedDict):
     last_clicked: str
     created_at: str
     updated_at: str
+    tag_id: Nullable[str]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
     project_id: str
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
     test_variants: NotRequired[Nullable[List[LinkWebhookEventTestVariantsTypedDict]]]
     r"""An array of A/B test URLs and the percentage of traffic to send to each URL."""
     clicks: NotRequired[float]
     r"""The number of clicks on the short link."""
     leads: NotRequired[float]
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+    conversions: NotRequired[float]
+    r"""The number of leads that converted to paying customers."""
     sales: NotRequired[float]
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
     sale_amount: NotRequired[float]
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
 
 class LinkWebhookEventLink(BaseModel):
@@ -950,15 +952,6 @@ class LinkWebhookEventLink(BaseModel):
 
     public_stats: Annotated[bool, pydantic.Field(alias="publicStats")]
 
-    tag_id: Annotated[
-        Nullable[str],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="tagId",
-        ),
-    ]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
-
     tags: Nullable[List[TagSchema]]
     r"""The tags assigned to the short link."""
 
@@ -1007,6 +1000,15 @@ class LinkWebhookEventLink(BaseModel):
 
     updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
 
+    tag_id: Annotated[
+        Nullable[str],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="tagId",
+        ),
+    ]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
+
     project_id: Annotated[
         str,
         pydantic.Field(
@@ -1014,7 +1016,7 @@ class LinkWebhookEventLink(BaseModel):
             alias="projectId",
         ),
     ]
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
 
     test_variants: Annotated[
         OptionalNullable[List[LinkWebhookEventTestVariants]],
@@ -1026,17 +1028,27 @@ class LinkWebhookEventLink(BaseModel):
     r"""The number of clicks on the short link."""
 
     leads: Optional[float] = 0
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+
+    conversions: Optional[float] = 0
+    r"""The number of leads that converted to paying customers."""
 
     sales: Optional[float] = 0
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["testVariants", "clicks", "leads", "sales", "saleAmount"]
+        optional_fields = [
+            "testVariants",
+            "clicks",
+            "leads",
+            "conversions",
+            "sales",
+            "saleAmount",
+        ]
         nullable_fields = [
             "externalId",
             "tenantId",
@@ -1051,7 +1063,6 @@ class LinkWebhookEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1064,6 +1075,7 @@ class LinkWebhookEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 

dub/models/components/partnerenrolledevent.py

@@ -39,11 +39,11 @@ class PartnerEnrolledEventLinkTypedDict(TypedDict):
     clicks: NotRequired[float]
     r"""The number of clicks on the short link."""
     leads: NotRequired[float]
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
     sales: NotRequired[float]
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
     sale_amount: NotRequired[float]
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
 
 class PartnerEnrolledEventLink(BaseModel):
@@ -66,13 +66,24 @@ class PartnerEnrolledEventLink(BaseModel):
     r"""The number of clicks on the short link."""
 
     leads: Optional[float] = 0
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
 
     sales: Optional[float] = 0
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
+
+
+class BannedReason(str, Enum):
+    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 PartnerEnrolledEventDataTypedDict(TypedDict):
@@ -86,50 +97,68 @@ class PartnerEnrolledEventDataTypedDict(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: Status
     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[PartnerEnrolledEventLinkTypedDict]]
     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 PartnerEnrolledEventData(BaseModel):
@@ -148,24 +177,6 @@ class PartnerEnrolledEventData(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)."""
 
@@ -177,17 +188,19 @@ class PartnerEnrolledEventData(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: Status
-    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: Status
+    r"""The status of the partner's enrollment in the program."""
 
     links: Nullable[List[PartnerEnrolledEventLink]]
     r"""The partner's referral links in this program."""
@@ -195,62 +208,176 @@ class PartnerEnrolledEventData(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 = []