dub 0.32.0__py3-none-any.whl → 0.34.0__py3-none-any.whl

dub/models/components/partnerenrolledevent.py

@@ -26,7 +26,7 @@ class Status(str, Enum):
     ARCHIVED = "archived"
 
 
-class PartnerEnrolledEventLinkTypedDict(TypedDict):
+class LinksTypedDict(TypedDict):
     id: str
     r"""The unique ID of the short link."""
     domain: str
@@ -49,7 +49,7 @@ class PartnerEnrolledEventLinkTypedDict(TypedDict):
     r"""The total dollar value of sales (in cents) generated by the short link."""
 
 
-class PartnerEnrolledEventLink(BaseModel):
+class Links(BaseModel):
     id: str
     r"""The unique ID of the short link."""
 
@@ -111,6 +111,8 @@ class PartnerEnrolledEventDataTypedDict(TypedDict):
     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."""
+    trusted_at: Nullable[str]
+    r"""The date when the partner received the trusted badge in the partner network."""
     program_id: str
     r"""The program's unique ID on Dub."""
     partner_id: str
@@ -120,7 +122,7 @@ class PartnerEnrolledEventDataTypedDict(TypedDict):
     created_at: str
     status: Status
     r"""The status of the partner's enrollment in the program."""
-    links: Nullable[List[PartnerEnrolledEventLinkTypedDict]]
+    links: Nullable[List[LinksTypedDict]]
     r"""The partner's referral links in this program."""
     description: NotRequired[Nullable[str]]
     r"""A brief description of the partner and their background."""
@@ -147,9 +149,21 @@ class PartnerEnrolledEventDataTypedDict(TypedDict):
     total_sales: NotRequired[float]
     r"""The total number of sales generated by the partner's links (includes recurring sales)"""
     total_sale_amount: NotRequired[float]
-    r"""The total amount of sales (in cents) generated by the partner's links"""
+    r"""Total revenue generated by the partner's links"""
     net_revenue: NotRequired[float]
-    r"""The total net revenue generated by the partner"""
+    r"""Net revenue after commissions (`Total Revenue - Total Commissions`)"""
+    earnings_per_click: NotRequired[Nullable[float]]
+    r"""Earnings Per Click (EPC) (`Total Revenue ÷ Total Clicks`)"""
+    average_lifetime_value: NotRequired[Nullable[float]]
+    r"""Average lifetime value for each paying customer (`Total Revenue ÷ Total Conversions`)"""
+    click_to_lead_rate: NotRequired[Nullable[float]]
+    r"""Percentage of clicks that become leads (`Total Leads ÷ Total Clicks`)"""
+    click_to_conversion_rate: NotRequired[Nullable[float]]
+    r"""Percentage of clicks that convert to paying customers (`Total Conversions ÷ Total Clicks`)"""
+    lead_to_conversion_rate: NotRequired[Nullable[float]]
+    r"""Percentage of leads that convert to paying customers (`Total Conversions ÷ Total Leads`)"""
+    return_on_ad_spend: NotRequired[Nullable[float]]
+    r"""Return On Ad Spend (ROAS) (`Total Revenue ÷ Total Commissions`)"""
     website: NotRequired[Nullable[str]]
     r"""The partner's website URL (including the https protocol)."""
     youtube: NotRequired[Nullable[str]]
@@ -194,6 +208,9 @@ class PartnerEnrolledEventData(BaseModel):
     ]
     r"""The date when the partner enabled payouts."""
 
+    trusted_at: Annotated[Nullable[str], pydantic.Field(alias="trustedAt")]
+    r"""The date when the partner received the trusted badge in the partner network."""
+
     program_id: Annotated[str, pydantic.Field(alias="programId")]
     r"""The program's unique ID on Dub."""
 
@@ -208,7 +225,7 @@ class PartnerEnrolledEventData(BaseModel):
     status: Status
     r"""The status of the partner's enrollment in the program."""
 
-    links: Nullable[List[PartnerEnrolledEventLink]]
+    links: Nullable[List[Links]]
     r"""The partner's referral links in this program."""
 
     description: OptionalNullable[str] = UNSET
@@ -270,10 +287,40 @@ class PartnerEnrolledEventData(BaseModel):
     total_sale_amount: Annotated[
         Optional[float], pydantic.Field(alias="totalSaleAmount")
     ] = 0
-    r"""The total amount of sales (in cents) generated by the partner's links"""
+    r"""Total revenue generated by the partner's links"""
 
     net_revenue: Annotated[Optional[float], pydantic.Field(alias="netRevenue")] = 0
-    r"""The total net revenue generated by the partner"""
+    r"""Net revenue after commissions (`Total Revenue - Total Commissions`)"""
+
+    earnings_per_click: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="earningsPerClick")
+    ] = UNSET
+    r"""Earnings Per Click (EPC) (`Total Revenue ÷ Total Clicks`)"""
+
+    average_lifetime_value: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="averageLifetimeValue")
+    ] = UNSET
+    r"""Average lifetime value for each paying customer (`Total Revenue ÷ Total Conversions`)"""
+
+    click_to_lead_rate: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="clickToLeadRate")
+    ] = UNSET
+    r"""Percentage of clicks that become leads (`Total Leads ÷ Total Clicks`)"""
+
+    click_to_conversion_rate: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="clickToConversionRate")
+    ] = UNSET
+    r"""Percentage of clicks that convert to paying customers (`Total Conversions ÷ Total Clicks`)"""
+
+    lead_to_conversion_rate: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="leadToConversionRate")
+    ] = UNSET
+    r"""Percentage of leads that convert to paying customers (`Total Conversions ÷ Total Leads`)"""
+
+    return_on_ad_spend: Annotated[
+        OptionalNullable[float], pydantic.Field(alias="returnOnAdSpend")
+    ] = UNSET
+    r"""Return On Ad Spend (ROAS) (`Total Revenue ÷ Total Commissions`)"""
 
     website: OptionalNullable[str] = UNSET
     r"""The partner's website URL (including the https protocol)."""
@@ -312,6 +359,12 @@ class PartnerEnrolledEventData(BaseModel):
             "totalSales",
             "totalSaleAmount",
             "netRevenue",
+            "earningsPerClick",
+            "averageLifetimeValue",
+            "clickToLeadRate",
+            "clickToConversionRate",
+            "leadToConversionRate",
+            "returnOnAdSpend",
             "website",
             "youtube",
             "twitter",
@@ -328,6 +381,7 @@ class PartnerEnrolledEventData(BaseModel):
             "paypalEmail",
             "stripeConnectId",
             "payoutsEnabledAt",
+            "trustedAt",
             "groupId",
             "tenantId",
             "links",
@@ -338,6 +392,12 @@ class PartnerEnrolledEventData(BaseModel):
             "applicationId",
             "bannedAt",
             "bannedReason",
+            "earningsPerClick",
+            "averageLifetimeValue",
+            "clickToLeadRate",
+            "clickToConversionRate",
+            "leadToConversionRate",
+            "returnOnAdSpend",
             "website",
             "youtube",
             "twitter",

dub/models/components/salecreatedevent.py

@@ -207,6 +207,7 @@ class SaleCreatedEventLinkTypedDict(TypedDict):
     archived: bool
     expires_at: str
     expired_url: Nullable[str]
+    disabled_at: str
     password: Nullable[str]
     r"""The password required to access the destination URL of the short link."""
     proxy: bool
@@ -249,8 +250,8 @@ class SaleCreatedEventLinkTypedDict(TypedDict):
     r"""The UTM term of the short link."""
     utm_content: Nullable[str]
     r"""The UTM content of the short link."""
-    test_started_at: Nullable[str]
-    test_completed_at: Nullable[str]
+    test_started_at: str
+    test_completed_at: str
     user_id: Nullable[str]
     workspace_id: str
     r"""The workspace ID of the short link."""
@@ -307,6 +308,8 @@ class SaleCreatedEventLink(BaseModel):
 
     expired_url: Annotated[Nullable[str], pydantic.Field(alias="expiredUrl")]
 
+    disabled_at: Annotated[str, pydantic.Field(alias="disabledAt")]
+
     password: Nullable[str]
     r"""The password required to access the destination URL of the short link."""
 
@@ -372,9 +375,9 @@ class SaleCreatedEventLink(BaseModel):
     utm_content: Nullable[str]
     r"""The UTM content of the short link."""
 
-    test_started_at: Annotated[Nullable[str], pydantic.Field(alias="testStartedAt")]
+    test_started_at: Annotated[str, pydantic.Field(alias="testStartedAt")]
 
-    test_completed_at: Annotated[Nullable[str], pydantic.Field(alias="testCompletedAt")]
+    test_completed_at: Annotated[str, pydantic.Field(alias="testCompletedAt")]
 
     user_id: Annotated[Nullable[str], pydantic.Field(alias="userId")]
 
@@ -459,8 +462,6 @@ class SaleCreatedEventLink(BaseModel):
             "utm_term",
             "utm_content",
             "testVariants",
-            "testStartedAt",
-            "testCompletedAt",
             "userId",
             "tagId",
         ]
@@ -491,14 +492,14 @@ class SaleCreatedEventLink(BaseModel):
         return m
 
 
-class SaleCreatedEventSaleTypedDict(TypedDict):
+class SaleTypedDict(TypedDict):
     amount: float
     currency: str
     payment_processor: str
     invoice_id: Nullable[str]
 
 
-class SaleCreatedEventSale(BaseModel):
+class Sale(BaseModel):
     amount: float
 
     currency: str
@@ -631,9 +632,9 @@ class SaleCreatedEventDataTypedDict(TypedDict):
     customer: SaleCreatedEventCustomerTypedDict
     click: SaleCreatedEventClickTypedDict
     link: SaleCreatedEventLinkTypedDict
-    sale: SaleCreatedEventSaleTypedDict
-    metadata: Nullable[Dict[str, Any]]
+    sale: SaleTypedDict
     partner: NotRequired[Nullable[SaleCreatedEventPartnerTypedDict]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class SaleCreatedEventData(BaseModel):
@@ -645,15 +646,15 @@ class SaleCreatedEventData(BaseModel):
 
     link: SaleCreatedEventLink
 
-    sale: SaleCreatedEventSale
-
-    metadata: Nullable[Dict[str, Any]]
+    sale: Sale
 
     partner: OptionalNullable[SaleCreatedEventPartner] = UNSET
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["partner"]
+        optional_fields = ["partner", "metadata"]
         nullable_fields = ["partner", "metadata"]
         null_default_fields = []
 

dub/models/components/webhookevent.py

@@ -8,6 +8,10 @@ from .commissioncreatedevent import (
 from .leadcreatedevent import LeadCreatedEvent, LeadCreatedEventTypedDict
 from .linkclickedevent import LinkClickedEvent, LinkClickedEventTypedDict
 from .linkwebhookevent import LinkWebhookEvent, LinkWebhookEventTypedDict
+from .partnerapplicationsubmittedevent import (
+    PartnerApplicationSubmittedEvent,
+    PartnerApplicationSubmittedEventTypedDict,
+)
 from .partnerenrolledevent import PartnerEnrolledEvent, PartnerEnrolledEventTypedDict
 from .salecreatedevent import SaleCreatedEvent, SaleCreatedEventTypedDict
 from typing import Union
@@ -22,6 +26,7 @@ WebhookEventTypedDict = TypeAliasType(
         LeadCreatedEventTypedDict,
         SaleCreatedEventTypedDict,
         PartnerEnrolledEventTypedDict,
+        PartnerApplicationSubmittedEventTypedDict,
         CommissionCreatedEventTypedDict,
     ],
 )
@@ -36,6 +41,7 @@ WebhookEvent = TypeAliasType(
         LeadCreatedEvent,
         SaleCreatedEvent,
         PartnerEnrolledEvent,
+        PartnerApplicationSubmittedEvent,
         CommissionCreatedEvent,
     ],
 )

dub/models/components/workspaceschema.py

@@ -105,6 +105,8 @@ class WorkspaceSchemaTypedDict(TypedDict):
     r"""The invite code of the workspace."""
     plan: Plan
     r"""The plan of the workspace."""
+    plan_tier: Nullable[float]
+    r"""The tier of the workspace's plan."""
     stripe_id: Nullable[str]
     r"""The Stripe ID of the workspace."""
     billing_cycle_start: float
@@ -185,6 +187,9 @@ class WorkspaceSchema(BaseModel):
     plan: Plan
     r"""The plan of the workspace."""
 
+    plan_tier: Annotated[Nullable[float], pydantic.Field(alias="planTier")]
+    r"""The tier of the workspace's plan."""
+
     stripe_id: Annotated[Nullable[str], pydantic.Field(alias="stripeId")]
     r"""The Stripe ID of the workspace."""
 
@@ -287,6 +292,7 @@ class WorkspaceSchema(BaseModel):
         nullable_fields = [
             "logo",
             "inviteCode",
+            "planTier",
             "stripeId",
             "paymentFailedAt",
             "stripeConnectId",