dub 0.23.1__py3-none-any.whl → 0.24.1__py3-none-any.whl

dub/models/components/partnerenrolledevent.py

@@ -14,6 +14,8 @@ class PartnerEnrolledEventEvent(str, Enum):
 
 
 class Status(str, Enum):
+    r"""The status of the partner's enrollment in the program."""
+
     PENDING = "pending"
     APPROVED = "approved"
     REJECTED = "rejected"
@@ -74,71 +76,141 @@ class PartnerEnrolledEventLink(BaseModel):
 
 class PartnerEnrolledEventDataTypedDict(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."""
     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."""
     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."""
     clicks: NotRequired[float]
+    r"""The total number of clicks on the partner's links."""
     leads: NotRequired[float]
+    r"""The total number of leads generated by the partner's links."""
     sales: NotRequired[float]
+    r"""The total number of sales generated by the partner's links."""
     sale_amount: NotRequired[float]
+    r"""The total amount of sales (in cents) generated by the partner's links."""
     earnings: NotRequired[float]
+    r"""The total earnings/commissions accrued by the partner's links."""
     application_id: NotRequired[Nullable[str]]
+    r"""If the partner submitted an application to join the program, this is the ID of the application."""
 
 
 class PartnerEnrolledEventData(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."""
 
     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)."""
 
     stripe_connect_id: Annotated[Nullable[str], pydantic.Field(alias="stripeConnectId")]
+    r"""The partner's Stripe Connect ID (for receiving payouts via Stripe)."""
 
     payouts_enabled_at: Annotated[
         Nullable[str], pydantic.Field(alias="payoutsEnabledAt")
     ]
+    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."""
 
     status: Status
+    r"""The status of the partner's enrollment in the program."""
 
     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."""
 
     links: Nullable[List[PartnerEnrolledEventLink]]
+    r"""The partner's referral links in this program."""
 
     description: OptionalNullable[str] = UNSET
+    r"""A brief description of the partner and their background."""
 
     clicks: Optional[float] = 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."""
 
     sales: Optional[float] = 0
+    r"""The total number of sales generated by the partner's links."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
+    r"""The total amount of sales (in cents) generated by the partner's links."""
 
     earnings: Optional[float] = 0
+    r"""The total earnings/commissions accrued by the partner's links."""
 
     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."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
@@ -156,6 +228,12 @@ class PartnerEnrolledEventData(BaseModel):
             "image",
             "description",
             "country",
+            "website",
+            "youtube",
+            "twitter",
+            "linkedin",
+            "instagram",
+            "tiktok",
             "paypalEmail",
             "stripeConnectId",
             "payoutsEnabledAt",

dub/models/operations/__init__.py

@@ -67,6 +67,7 @@ from .createpartner import (
     CreatePartnerRequestBodyTypedDict,
     CreatePartnerResponseBody,
     CreatePartnerResponseBodyTypedDict,
+    CreatePartnerStatus,
     CreatePartnerTagIds,
     CreatePartnerTagIdsTypedDict,
     CreatePartnerTagNames,
@@ -75,7 +76,6 @@ from .createpartner import (
     CreatePartnerTestVariantsTypedDict,
     LinkProps,
     LinkPropsTypedDict,
-    Status,
 )
 from .createpartnerlink import (
     CreatePartnerLinkLinkProps,
@@ -203,6 +203,19 @@ from .gettags import (
     IdsTypedDict,
 )
 from .getworkspace import GetWorkspaceRequest, GetWorkspaceRequestTypedDict
+from .listcommissions import (
+    ListCommissionsQueryParamInterval,
+    ListCommissionsQueryParamSortBy,
+    ListCommissionsQueryParamSortOrder,
+    ListCommissionsRequest,
+    ListCommissionsRequestTypedDict,
+    ListCommissionsResponseBody,
+    ListCommissionsResponseBodyTypedDict,
+    ListCommissionsStatus,
+    ListCommissionsType,
+    QueryParamStatus,
+    Type,
+)
 from .listdomains import (
     ListDomainsRequest,
     ListDomainsRequestTypedDict,
@@ -272,6 +285,17 @@ from .tracksale import (
     TrackSaleResponseBody,
     TrackSaleResponseBodyTypedDict,
 )
+from .updatecommission import (
+    Status,
+    UpdateCommissionRequest,
+    UpdateCommissionRequestBody,
+    UpdateCommissionRequestBodyTypedDict,
+    UpdateCommissionRequestTypedDict,
+    UpdateCommissionResponseBody,
+    UpdateCommissionResponseBodyTypedDict,
+    UpdateCommissionStatus,
+    UpdateCommissionType,
+)
 from .updatecustomer import (
     UpdateCustomerDiscount,
     UpdateCustomerDiscountTypedDict,
@@ -312,14 +336,6 @@ from .updatelink import (
     UpdateLinkTestVariants,
     UpdateLinkTestVariantsTypedDict,
 )
-from .updatepartnersale import (
-    Type,
-    UpdatePartnerSaleRequestBody,
-    UpdatePartnerSaleRequestBodyTypedDict,
-    UpdatePartnerSaleResponseBody,
-    UpdatePartnerSaleResponseBodyTypedDict,
-    UpdatePartnerSaleStatus,
-)
 from .updatetag import (
     UpdateTagColor,
     UpdateTagRequest,
@@ -414,6 +430,7 @@ __all__ = [
     "CreatePartnerRequestBodyTypedDict",
     "CreatePartnerResponseBody",
     "CreatePartnerResponseBodyTypedDict",
+    "CreatePartnerStatus",
     "CreatePartnerTagIds",
     "CreatePartnerTagIdsTypedDict",
     "CreatePartnerTagNames",
@@ -515,6 +532,15 @@ __all__ = [
     "LinkProps",
     "LinkPropsTypedDict",
     "LinkTypedDict",
+    "ListCommissionsQueryParamInterval",
+    "ListCommissionsQueryParamSortBy",
+    "ListCommissionsQueryParamSortOrder",
+    "ListCommissionsRequest",
+    "ListCommissionsRequestTypedDict",
+    "ListCommissionsResponseBody",
+    "ListCommissionsResponseBodyTypedDict",
+    "ListCommissionsStatus",
+    "ListCommissionsType",
     "ListDomainsRequest",
     "ListDomainsRequestTypedDict",
     "ListDomainsResponse",
@@ -538,6 +564,7 @@ __all__ = [
     "QueryParamInterval",
     "QueryParamSortBy",
     "QueryParamSortOrder",
+    "QueryParamStatus",
     "QueryParamTagIds",
     "QueryParamTagIdsTypedDict",
     "QueryParamTagNames",
@@ -587,6 +614,14 @@ __all__ = [
     "Trigger",
     "Two",
     "Type",
+    "UpdateCommissionRequest",
+    "UpdateCommissionRequestBody",
+    "UpdateCommissionRequestBodyTypedDict",
+    "UpdateCommissionRequestTypedDict",
+    "UpdateCommissionResponseBody",
+    "UpdateCommissionResponseBodyTypedDict",
+    "UpdateCommissionStatus",
+    "UpdateCommissionType",
     "UpdateCustomerDiscount",
     "UpdateCustomerDiscountTypedDict",
     "UpdateCustomerLink",
@@ -619,11 +654,6 @@ __all__ = [
     "UpdateLinkTagNamesTypedDict",
     "UpdateLinkTestVariants",
     "UpdateLinkTestVariantsTypedDict",
-    "UpdatePartnerSaleRequestBody",
-    "UpdatePartnerSaleRequestBodyTypedDict",
-    "UpdatePartnerSaleResponseBody",
-    "UpdatePartnerSaleResponseBodyTypedDict",
-    "UpdatePartnerSaleStatus",
     "UpdateTagColor",
     "UpdateTagRequest",
     "UpdateTagRequestBody",

dub/models/operations/createcustomer.py

@@ -130,19 +130,27 @@ class CreateCustomerLink(BaseModel):
 
 class CreateCustomerPartnerTypedDict(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."""
 
 
 class CreateCustomerPartner(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."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):

dub/models/operations/createpartner.py

@@ -640,7 +640,9 @@ class CreatePartnerRequestBody(BaseModel):
         return m
 
 
-class Status(str, Enum):
+class CreatePartnerStatus(str, Enum):
+    r"""The status of the partner's enrollment in the program."""
+
     PENDING = "pending"
     APPROVED = "approved"
     REJECTED = "rejected"
@@ -703,73 +705,143 @@ class CreatePartnerResponseBodyTypedDict(TypedDict):
     r"""The created partner"""
 
     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."""
     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."""
     created_at: str
-    status: Status
+    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."""
     clicks: NotRequired[float]
+    r"""The total number of clicks on the partner's links."""
     leads: NotRequired[float]
+    r"""The total number of leads generated by the partner's links."""
     sales: NotRequired[float]
+    r"""The total number of sales generated by the partner's links."""
     sale_amount: NotRequired[float]
+    r"""The total amount of sales (in cents) generated by the partner's links."""
     earnings: NotRequired[float]
+    r"""The total earnings/commissions accrued by the partner's links."""
     application_id: NotRequired[Nullable[str]]
+    r"""If the partner submitted an application to join the program, this is the ID of the application."""
 
 
 class CreatePartnerResponseBody(BaseModel):
     r"""The created partner"""
 
     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."""
 
     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)."""
 
     stripe_connect_id: Annotated[Nullable[str], pydantic.Field(alias="stripeConnectId")]
+    r"""The partner's Stripe Connect ID (for receiving payouts via Stripe)."""
 
     payouts_enabled_at: Annotated[
         Nullable[str], pydantic.Field(alias="payoutsEnabledAt")
     ]
+    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."""
 
-    status: Status
+    status: CreatePartnerStatus
+    r"""The status of the partner's enrollment in the program."""
 
     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."""
 
     links: Nullable[List[CreatePartnerLink]]
+    r"""The partner's referral links in this program."""
 
     description: OptionalNullable[str] = UNSET
+    r"""A brief description of the partner and their background."""
 
     clicks: Optional[float] = 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."""
 
     sales: Optional[float] = 0
+    r"""The total number of sales generated by the partner's links."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
+    r"""The total amount of sales (in cents) generated by the partner's links."""
 
     earnings: Optional[float] = 0
+    r"""The total earnings/commissions accrued by the partner's links."""
 
     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."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
@@ -787,6 +859,12 @@ class CreatePartnerResponseBody(BaseModel):
             "image",
             "description",
             "country",
+            "website",
+            "youtube",
+            "twitter",
+            "linkedin",
+            "instagram",
+            "tiktok",
             "paypalEmail",
             "stripeConnectId",
             "payoutsEnabledAt",

dub/models/operations/getcustomer.py

@@ -98,19 +98,27 @@ class GetCustomerLink(BaseModel):
 
 class GetCustomerPartnerTypedDict(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."""
 
 
 class GetCustomerPartner(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."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):

dub/models/operations/getcustomers.py

@@ -182,19 +182,27 @@ class GetCustomersLink(BaseModel):
 
 class GetCustomersPartnerTypedDict(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."""
 
 
 class GetCustomersPartner(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."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):