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

dub/models/operations/createcustomer.py

@@ -17,6 +17,8 @@ class CreateCustomerRequestBodyTypedDict(TypedDict):
     r"""Name of the customer in the client's app. If not provided, a random name will be generated."""
     avatar: NotRequired[Nullable[str]]
     r"""Avatar URL of the customer in the client's app."""
+    stripe_customer_id: NotRequired[Nullable[str]]
+    r"""The customer's Stripe customer ID. Useful for attribution recurring sale events to the partner who referred the customer."""
 
 
 class CreateCustomerRequestBody(BaseModel):
@@ -32,10 +34,15 @@ class CreateCustomerRequestBody(BaseModel):
     avatar: OptionalNullable[str] = UNSET
     r"""Avatar URL of the customer in the client's app."""
 
+    stripe_customer_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="stripeCustomerId")
+    ] = UNSET
+    r"""The customer's Stripe customer ID. Useful for attribution recurring sale events to the partner who referred the customer."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["email", "name", "avatar"]
-        nullable_fields = ["email", "name", "avatar"]
+        optional_fields = ["email", "name", "avatar", "stripeCustomerId"]
+        nullable_fields = ["email", "name", "avatar", "stripeCustomerId"]
         null_default_fields = []
 
         serialized = handler(self)
@@ -223,9 +230,9 @@ class CreateCustomerDiscount(BaseModel):
         optional_fields = ["description", "partnersCount"]
         nullable_fields = [
             "maxDuration",
-            "description",
             "couponId",
             "couponTestId",
+            "description",
             "partnersCount",
         ]
         null_default_fields = []

dub/models/operations/createfolder.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from dub.types import BaseModel, Nullable, OptionalNullable, UNSET_SENTINEL
+from dub.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from enum import Enum
 import pydantic
 from pydantic import model_serializer
@@ -18,6 +18,8 @@ class AccessLevel(str, Enum):
 class CreateFolderRequestBodyTypedDict(TypedDict):
     name: str
     r"""The name of the folder."""
+    description: NotRequired[Nullable[str]]
+    r"""The description of the folder."""
     access_level: NotRequired[Nullable[AccessLevel]]
     r"""The access level of the folder within the workspace."""
 
@@ -26,6 +28,9 @@ class CreateFolderRequestBody(BaseModel):
     name: str
     r"""The name of the folder."""
 
+    description: OptionalNullable[str] = UNSET
+    r"""The description of the folder."""
+
     access_level: Annotated[
         OptionalNullable[AccessLevel], pydantic.Field(alias="accessLevel")
     ] = None
@@ -33,8 +38,8 @@ class CreateFolderRequestBody(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["accessLevel"]
-        nullable_fields = ["accessLevel"]
+        optional_fields = ["description", "accessLevel"]
+        nullable_fields = ["description", "accessLevel"]
         null_default_fields = ["accessLevel"]
 
         serialized = handler(self)

dub/models/operations/createlink.py

@@ -43,7 +43,7 @@ class CreateLinkRequestBodyTypedDict(TypedDict):
     url: str
     r"""The destination URL of the short link."""
     domain: NotRequired[str]
-    r"""The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains)."""
+    r"""The domain of the short link (without protocol). If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains)."""
     key: NotRequired[str]
     r"""The short link slug. If not provided, a random 7-character slug will be generated."""
     key_length: NotRequired[float]
@@ -127,7 +127,7 @@ class CreateLinkRequestBody(BaseModel):
     r"""The destination URL of the short link."""
 
     domain: Optional[str] = None
-    r"""The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains)."""
+    r"""The domain of the short link (without protocol). If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains)."""
 
     key: Optional[str] = None
     r"""The short link slug. If not provided, a random 7-character slug will be generated."""

dub/models/operations/createpartner.py

@@ -401,6 +401,7 @@ class CreatePartnerStatus(str, Enum):
     REJECTED = "rejected"
     INVITED = "invited"
     DECLINED = "declined"
+    DEACTIVATED = "deactivated"
     BANNED = "banned"
     ARCHIVED = "archived"
 
@@ -420,6 +421,8 @@ class CreatePartnerLinkTypedDict(TypedDict):
     r"""The number of clicks on the short link."""
     leads: NotRequired[float]
     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 total number of sales (includes recurring sales) generated by the short link."""
     sale_amount: NotRequired[float]
@@ -448,6 +451,9 @@ class CreatePartnerLink(BaseModel):
     leads: Optional[float] = 0
     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 total number of sales (includes recurring sales) generated by the short link."""
 
@@ -467,12 +473,14 @@ class BannedReason(str, Enum):
 
 
 class CreatePartnerResponseBodyTypedDict(TypedDict):
-    r"""The created partner"""
+    r"""The created or updated partner"""
 
     id: str
     r"""The partner's unique ID on Dub."""
     name: str
     r"""The partner's full legal name."""
+    company_name: Nullable[str]
+    r"""If the partner profile type is a company, this is the partner's legal company name."""
     email: Nullable[str]
     r"""The partner's email address. Should be a unique value across Dub."""
     image: Nullable[str]
@@ -501,7 +509,7 @@ class CreatePartnerResponseBodyTypedDict(TypedDict):
     group_id: NotRequired[Nullable[str]]
     r"""The partner's group ID on Dub."""
     total_commissions: NotRequired[float]
-    r"""The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false."""
+    r"""The total commissions paid to the partner for their referrals"""
     click_reward_id: NotRequired[Nullable[str]]
     lead_reward_id: NotRequired[Nullable[str]]
     sale_reward_id: NotRequired[Nullable[str]]
@@ -512,43 +520,34 @@ class CreatePartnerResponseBodyTypedDict(TypedDict):
     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. Defaults to 0 if `includeExpandedFields` is false."""
-    leads: NotRequired[float]
-    r"""The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
-    conversions: NotRequired[float]
-    r"""The total number of leads that converted to paying customers. Defaults to 0 if `includeExpandedFields` is false."""
-    sales: NotRequired[float]
-    r"""The total number of sales generated by the partner's links (includes recurring sales). 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. Defaults to 0 if `includeExpandedFields` is false."""
+    total_clicks: NotRequired[float]
+    r"""The total number of clicks on the partner's links"""
+    total_leads: NotRequired[float]
+    r"""The total number of leads generated by the partner's links"""
+    total_conversions: NotRequired[float]
+    r"""The total number of leads that converted to paying customers"""
+    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"""
     net_revenue: NotRequired[float]
-    r"""The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false."""
+    r"""The total net revenue generated by the partner"""
     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):
-    r"""The created partner"""
+    r"""The created or updated partner"""
 
     id: str
     r"""The partner's unique ID on Dub."""
@@ -556,6 +555,9 @@ class CreatePartnerResponseBody(BaseModel):
     name: str
     r"""The partner's full legal name."""
 
+    company_name: Annotated[Nullable[str], pydantic.Field(alias="companyName")]
+    r"""If the partner profile type is a company, this is the partner's legal company name."""
+
     email: Nullable[str]
     r"""The partner's email address. Should be a unique value across Dub."""
 
@@ -602,7 +604,7 @@ class CreatePartnerResponseBody(BaseModel):
     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."""
+    r"""The total commissions paid to the partner for their referrals"""
 
     click_reward_id: Annotated[
         OptionalNullable[str], pydantic.Field(alias="clickRewardId")
@@ -635,78 +637,46 @@ class CreatePartnerResponseBody(BaseModel):
     ] = 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. Defaults to 0 if `includeExpandedFields` is false."""
+    total_clicks: Annotated[Optional[float], pydantic.Field(alias="totalClicks")] = 0
+    r"""The total number of clicks on the partner's links"""
 
-    leads: Optional[float] = 0
-    r"""The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
+    total_leads: Annotated[Optional[float], pydantic.Field(alias="totalLeads")] = 0
+    r"""The total number of leads generated by the partner's links"""
 
-    conversions: Optional[float] = 0
-    r"""The total number of leads that converted to paying customers. Defaults to 0 if `includeExpandedFields` is false."""
+    total_conversions: Annotated[
+        Optional[float], pydantic.Field(alias="totalConversions")
+    ] = 0
+    r"""The total number of leads that converted to paying customers"""
 
-    sales: Optional[float] = 0
-    r"""The total number of sales generated by the partner's links (includes recurring sales). Defaults to 0 if `includeExpandedFields` is false."""
+    total_sales: Annotated[Optional[float], pydantic.Field(alias="totalSales")] = 0
+    r"""The total number of sales generated by the partner's links (includes recurring sales)"""
 
-    sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false."""
+    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"""
 
     net_revenue: Annotated[Optional[float], pydantic.Field(alias="netRevenue")] = 0
-    r"""The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false."""
+    r"""The total net revenue generated by the partner"""
 
     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 = [
@@ -720,29 +690,21 @@ class CreatePartnerResponseBody(BaseModel):
             "applicationId",
             "bannedAt",
             "bannedReason",
-            "clicks",
-            "leads",
-            "conversions",
-            "sales",
-            "saleAmount",
+            "totalClicks",
+            "totalLeads",
+            "totalConversions",
+            "totalSales",
+            "totalSaleAmount",
             "netRevenue",
             "website",
-            "websiteTxtRecord",
-            "websiteVerifiedAt",
             "youtube",
-            "youtubeVerifiedAt",
-            "youtubeSubscriberCount",
-            "youtubeViewCount",
             "twitter",
-            "twitterVerifiedAt",
             "linkedin",
-            "linkedinVerifiedAt",
             "instagram",
-            "instagramVerifiedAt",
             "tiktok",
-            "tiktokVerifiedAt",
         ]
         nullable_fields = [
+            "companyName",
             "email",
             "image",
             "description",
@@ -761,20 +723,11 @@ class CreatePartnerResponseBody(BaseModel):
             "bannedAt",
             "bannedReason",
             "website",
-            "websiteTxtRecord",
-            "websiteVerifiedAt",
             "youtube",
-            "youtubeVerifiedAt",
-            "youtubeSubscriberCount",
-            "youtubeViewCount",
             "twitter",
-            "twitterVerifiedAt",
             "linkedin",
-            "linkedinVerifiedAt",
             "instagram",
-            "instagramVerifiedAt",
             "tiktok",
-            "tiktokVerifiedAt",
         ]
         null_default_fields = []
 

dub/models/operations/getcustomer.py

@@ -191,9 +191,9 @@ class GetCustomerDiscount(BaseModel):
         optional_fields = ["description", "partnersCount"]
         nullable_fields = [
             "maxDuration",
-            "description",
             "couponId",
             "couponTestId",
+            "description",
             "partnersCount",
         ]
         null_default_fields = []

dub/models/operations/getcustomers.py

@@ -275,9 +275,9 @@ class Discount(BaseModel):
         optional_fields = ["description", "partnersCount"]
         nullable_fields = [
             "maxDuration",
-            "description",
             "couponId",
             "couponTestId",
+            "description",
             "partnersCount",
         ]
         null_default_fields = []

dub/models/operations/listcommissions.py

@@ -64,7 +64,9 @@ class ListCommissionsRequestTypedDict(TypedDict):
     payout_id: NotRequired[str]
     r"""Filter the list of commissions by the associated payout."""
     partner_id: NotRequired[str]
-    r"""Filter the list of commissions by the associated partner."""
+    r"""Filter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`."""
+    tenant_id: NotRequired[str]
+    r"""Filter the list of commissions by the associated partner's `tenantId` (their unique ID within your database)."""
     group_id: NotRequired[str]
     r"""Filter the list of commissions by the associated partner group."""
     invoice_id: NotRequired[str]
@@ -112,7 +114,14 @@ class ListCommissionsRequest(BaseModel):
         pydantic.Field(alias="partnerId"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Filter the list of commissions by the associated partner."""
+    r"""Filter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`."""
+
+    tenant_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="tenantId"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Filter the list of commissions by the associated partner's `tenantId` (their unique ID within your database)."""
 
     group_id: Annotated[
         Optional[str],

dub/models/operations/listevents.py

@@ -168,6 +168,8 @@ class ListEventsRequestTypedDict(TypedDict):
     r"""The UTM term of the short link."""
     utm_content: NotRequired[Nullable[str]]
     r"""The UTM content of the short link."""
+    ref: NotRequired[Nullable[str]]
+    r"""The ref of the short link."""
     page: NotRequired[float]
     limit: NotRequired[float]
     sort_order: NotRequired[QueryParamSortOrder]
@@ -406,6 +408,12 @@ class ListEventsRequest(BaseModel):
     ] = UNSET
     r"""The UTM content of the short link."""
 
+    ref: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The ref of the short link."""
+
     page: Annotated[
         Optional[float],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -475,6 +483,7 @@ class ListEventsRequest(BaseModel):
             "utm_campaign",
             "utm_term",
             "utm_content",
+            "ref",
             "page",
             "limit",
             "sortOrder",
@@ -487,6 +496,7 @@ class ListEventsRequest(BaseModel):
             "utm_campaign",
             "utm_term",
             "utm_content",
+            "ref",
         ]
         null_default_fields = []