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

dub/models/components/commissioncreatedevent.py

@@ -0,0 +1,281 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dub.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from enum import Enum
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CommissionCreatedEventEvent(str, Enum):
+    COMMISSION_CREATED = "commission.created"
+
+
+class CommissionCreatedEventType(str, Enum):
+    CLICK = "click"
+    LEAD = "lead"
+    SALE = "sale"
+    CUSTOM = "custom"
+
+
+class CommissionCreatedEventStatus(str, Enum):
+    PENDING = "pending"
+    PROCESSED = "processed"
+    PAID = "paid"
+    REFUNDED = "refunded"
+    DUPLICATE = "duplicate"
+    FRAUD = "fraud"
+    CANCELED = "canceled"
+
+
+class PartnerTypedDict(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 Partner(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 CommissionCreatedEventCustomerTypedDict(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 CommissionCreatedEventCustomer(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 CommissionCreatedEventDataTypedDict(TypedDict):
+    id: str
+    r"""The commission's unique ID on Dub."""
+    amount: float
+    earnings: float
+    currency: str
+    status: CommissionCreatedEventStatus
+    invoice_id: Nullable[str]
+    description: Nullable[str]
+    quantity: float
+    created_at: str
+    updated_at: str
+    partner: PartnerTypedDict
+    type: NotRequired[CommissionCreatedEventType]
+    user_id: NotRequired[Nullable[str]]
+    r"""The user who created the manual commission."""
+    customer: NotRequired[Nullable[CommissionCreatedEventCustomerTypedDict]]
+
+
+class CommissionCreatedEventData(BaseModel):
+    id: str
+    r"""The commission's unique ID on Dub."""
+
+    amount: float
+
+    earnings: float
+
+    currency: str
+
+    status: CommissionCreatedEventStatus
+
+    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: Partner
+
+    type: Optional[CommissionCreatedEventType] = None
+
+    user_id: Annotated[OptionalNullable[str], pydantic.Field(alias="userId")] = UNSET
+    r"""The user who created the manual commission."""
+
+    customer: OptionalNullable[CommissionCreatedEventCustomer] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "userId", "customer"]
+        nullable_fields = ["invoiceId", "description", "userId", "customer"]
+        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 CommissionCreatedEventTypedDict(TypedDict):
+    r"""Triggered when a commission is created for a partner."""
+
+    id: str
+    event: CommissionCreatedEventEvent
+    created_at: str
+    data: CommissionCreatedEventDataTypedDict
+
+
+class CommissionCreatedEvent(BaseModel):
+    r"""Triggered when a commission is created for a partner."""
+
+    id: str
+
+    event: CommissionCreatedEventEvent
+
+    created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+
+    data: CommissionCreatedEventData

dub/models/components/leadcreatedevent.py

@@ -111,6 +111,7 @@ class LeadCreatedEventClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class LeadCreatedEventClick(BaseModel):
@@ -142,6 +143,38 @@ class LeadCreatedEventClick(BaseModel):
 
     ip: str
 
+    trigger: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["trigger"]
+        nullable_fields = ["trigger"]
+        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 LeadCreatedEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
@@ -953,8 +986,6 @@ class LeadCreatedEventLinkTypedDict(TypedDict):
     geo: Nullable[LeadCreatedEventGeoTypedDict]
     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]
@@ -985,18 +1016,22 @@ class LeadCreatedEventLinkTypedDict(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[LeadCreatedEventTestVariantsTypedDict]]]
     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 LeadCreatedEventLink(BaseModel):
@@ -1063,15 +1098,6 @@ class LeadCreatedEventLink(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."""
 
@@ -1120,6 +1146,15 @@ class LeadCreatedEventLink(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(
@@ -1127,7 +1162,7 @@ class LeadCreatedEventLink(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[LeadCreatedEventTestVariants]],
@@ -1139,17 +1174,27 @@ class LeadCreatedEventLink(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",
@@ -1164,7 +1209,6 @@ class LeadCreatedEventLink(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1177,6 +1221,7 @@ class LeadCreatedEventLink(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []