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

dub/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "dub"
-__version__: str = "0.27.1"
+__version__: str = "0.27.2"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.656.5"
-__user_agent__: str = "speakeasy-sdk/python 0.27.1 2.656.5 0.0.1 dub"
+__gen_version__: str = "2.662.0"
+__user_agent__: str = "speakeasy-sdk/python 0.27.2 2.662.0 0.0.1 dub"
 
 try:
     if __package__ is not None:

dub/models/components/__init__.py

@@ -51,6 +51,19 @@ if TYPE_CHECKING:
         Link,
         LinkTypedDict,
     )
+    from .commissioncreatedevent import (
+        CommissionCreatedEvent,
+        CommissionCreatedEventCustomer,
+        CommissionCreatedEventCustomerTypedDict,
+        CommissionCreatedEventData,
+        CommissionCreatedEventDataTypedDict,
+        CommissionCreatedEventEvent,
+        CommissionCreatedEventStatus,
+        CommissionCreatedEventType,
+        CommissionCreatedEventTypedDict,
+        Partner,
+        PartnerTypedDict,
+    )
     from .continentcode import ContinentCode
     from .countrycode import CountryCode
     from .domainschema import (
@@ -145,6 +158,7 @@ if TYPE_CHECKING:
         PartnerAnalyticsTopLinksTypedDict,
     )
     from .partnerenrolledevent import (
+        BannedReason,
         PartnerEnrolledEvent,
         PartnerEnrolledEventData,
         PartnerEnrolledEventDataTypedDict,
@@ -236,6 +250,7 @@ __all__ = [
     "AnalyticsTopUrlsTypedDict",
     "AnalyticsTriggers",
     "AnalyticsTriggersTypedDict",
+    "BannedReason",
     "City",
     "Click",
     "ClickEvent",
@@ -247,6 +262,15 @@ __all__ = [
     "ClickTypedDict",
     "Code",
     "Color",
+    "CommissionCreatedEvent",
+    "CommissionCreatedEventCustomer",
+    "CommissionCreatedEventCustomerTypedDict",
+    "CommissionCreatedEventData",
+    "CommissionCreatedEventDataTypedDict",
+    "CommissionCreatedEventEvent",
+    "CommissionCreatedEventStatus",
+    "CommissionCreatedEventType",
+    "CommissionCreatedEventTypedDict",
     "Continent",
     "ContinentCode",
     "CountryCode",
@@ -319,6 +343,7 @@ __all__ = [
     "LinkWebhookEventTestVariantsTypedDict",
     "LinkWebhookEventTypedDict",
     "One",
+    "Partner",
     "PartnerAnalyticsCount",
     "PartnerAnalyticsCountTypedDict",
     "PartnerAnalyticsTimeseries",
@@ -332,6 +357,7 @@ __all__ = [
     "PartnerEnrolledEventLink",
     "PartnerEnrolledEventLinkTypedDict",
     "PartnerEnrolledEventTypedDict",
+    "PartnerTypedDict",
     "PaymentProcessor",
     "Plan",
     "Region",
@@ -434,6 +460,17 @@ _dynamic_imports: dict[str, str] = {
     "Event": ".clickevent",
     "Link": ".clickevent",
     "LinkTypedDict": ".clickevent",
+    "CommissionCreatedEvent": ".commissioncreatedevent",
+    "CommissionCreatedEventCustomer": ".commissioncreatedevent",
+    "CommissionCreatedEventCustomerTypedDict": ".commissioncreatedevent",
+    "CommissionCreatedEventData": ".commissioncreatedevent",
+    "CommissionCreatedEventDataTypedDict": ".commissioncreatedevent",
+    "CommissionCreatedEventEvent": ".commissioncreatedevent",
+    "CommissionCreatedEventStatus": ".commissioncreatedevent",
+    "CommissionCreatedEventType": ".commissioncreatedevent",
+    "CommissionCreatedEventTypedDict": ".commissioncreatedevent",
+    "Partner": ".commissioncreatedevent",
+    "PartnerTypedDict": ".commissioncreatedevent",
     "ContinentCode": ".continentcode",
     "CountryCode": ".countrycode",
     "DomainSchema": ".domainschema",
@@ -515,6 +552,7 @@ _dynamic_imports: dict[str, str] = {
     "PartnerAnalyticsTimeseriesTypedDict": ".partneranalyticstimeseries",
     "PartnerAnalyticsTopLinks": ".partneranalyticstoplinks",
     "PartnerAnalyticsTopLinksTypedDict": ".partneranalyticstoplinks",
+    "BannedReason": ".partnerenrolledevent",
     "PartnerEnrolledEvent": ".partnerenrolledevent",
     "PartnerEnrolledEventData": ".partnerenrolledevent",
     "PartnerEnrolledEventDataTypedDict": ".partnerenrolledevent",

dub/models/components/analyticstriggers.py

@@ -13,6 +13,8 @@ class Trigger(str, Enum):
 
     QR = "qr"
     LINK = "link"
+    PAGEVIEW = "pageview"
+    DEEPLINK = "deeplink"
 
 
 class AnalyticsTriggersTypedDict(TypedDict):

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