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

dub/models/components/analyticstopurls.py

@@ -1,8 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 import pydantic
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -35,3 +36,19 @@ class AnalyticsTopUrls(BaseModel):
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
     r"""The total amount of sales from this URL, in cents"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["clicks", "leads", "sales", "saleAmount"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

dub/models/components/analyticstriggers.py

@@ -1,9 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import pydantic
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -45,3 +46,19 @@ class AnalyticsTriggers(BaseModel):
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
     r"""The total amount of sales from this trigger method, in cents"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["clicks", "leads", "sales", "saleAmount"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

dub/models/components/commissioncreatedevent.py

@@ -89,31 +89,28 @@ class CommissionCreatedEventPartner(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["groupId"]
-        nullable_fields = ["email", "image", "payoutsEnabledAt", "country", "groupId"]
-        null_default_fields = []
-
+        optional_fields = set(["groupId"])
+        nullable_fields = set(
+            ["email", "image", "payoutsEnabledAt", "country", "groupId"]
+        )
         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
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m
 
@@ -121,36 +118,42 @@ class CommissionCreatedEventPartner(BaseModel):
 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."""
+    external_id: str
+    r"""Unique identifier for the customer in the client's app."""
     created_at: str
-    r"""The date the customer was created."""
+    r"""The date the customer was created (usually the signup date or trial start date)."""
     email: NotRequired[Nullable[str]]
     r"""Email of the customer."""
     avatar: NotRequired[Nullable[str]]
     r"""Avatar URL of the customer."""
+    stripe_customer_id: NotRequired[Nullable[str]]
+    r"""The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred 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."""
+    first_sale_at: NotRequired[Nullable[str]]
+    r"""The date the customer made their first sale. Useful for calculating the time to first sale and LTV."""
+    subscription_canceled_at: NotRequired[Nullable[str]]
+    r"""The date the customer canceled their subscription. Useful for calculating LTV and churn rate."""
 
 
 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."""
 
+    external_id: Annotated[str, pydantic.Field(alias="externalId")]
+    r"""Unique identifier for the customer in the client's app."""
+
     created_at: Annotated[str, pydantic.Field(alias="createdAt")]
-    r"""The date the customer was created."""
+    r"""The date the customer was created (usually the signup date or trial start date)."""
 
     email: OptionalNullable[str] = UNSET
     r"""Email of the customer."""
@@ -158,6 +161,11 @@ class CommissionCreatedEventCustomer(BaseModel):
     avatar: OptionalNullable[str] = UNSET
     r"""Avatar URL of the customer."""
 
+    stripe_customer_id: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="stripeCustomerId")
+    ] = UNSET
+    r"""The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred the customer."""
+
     country: OptionalNullable[str] = UNSET
     r"""Country of the customer."""
 
@@ -169,35 +177,87 @@ class CommissionCreatedEventCustomer(BaseModel):
     ] = UNSET
     r"""Total amount of sales for the customer."""
 
+    first_sale_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="firstSaleAt")
+    ] = UNSET
+    r"""The date the customer made their first sale. Useful for calculating the time to first sale and LTV."""
+
+    subscription_canceled_at: Annotated[
+        OptionalNullable[str], pydantic.Field(alias="subscriptionCanceledAt")
+    ] = UNSET
+    r"""The date the customer canceled their subscription. Useful for calculating LTV and churn rate."""
+
     @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 = []
-
+        optional_fields = set(
+            [
+                "email",
+                "avatar",
+                "stripeCustomerId",
+                "country",
+                "sales",
+                "saleAmount",
+                "firstSaleAt",
+                "subscriptionCanceledAt",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "email",
+                "avatar",
+                "stripeCustomerId",
+                "country",
+                "sales",
+                "saleAmount",
+                "firstSaleAt",
+                "subscriptionCanceledAt",
+            ]
+        )
         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)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
-            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
+        return m
 
-            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 CommissionCreatedEventLinkTypedDict(TypedDict):
+    id: str
+    r"""The unique ID of the short link."""
+    short_link: str
+    r"""The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`)."""
+    domain: 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)."""
+    key: str
+    r"""The short link slug. If not provided, a random 7-character slug will be generated."""
+
+
+class CommissionCreatedEventLink(BaseModel):
+    id: str
+    r"""The unique ID of the short link."""
+
+    short_link: Annotated[str, pydantic.Field(alias="shortLink")]
+    r"""The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`)."""
+
+    domain: 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)."""
+
+    key: str
+    r"""The short link slug. If not provided, a random 7-character slug will be generated."""
 
 
 class CommissionCreatedEventDataTypedDict(TypedDict):
@@ -213,6 +273,7 @@ class CommissionCreatedEventDataTypedDict(TypedDict):
     created_at: str
     updated_at: str
     partner: CommissionCreatedEventPartnerTypedDict
+    link: Nullable[CommissionCreatedEventLinkTypedDict]
     type: NotRequired[CommissionCreatedEventType]
     user_id: NotRequired[Nullable[str]]
     r"""The user who created the manual commission."""
@@ -243,6 +304,8 @@ class CommissionCreatedEventData(BaseModel):
 
     partner: CommissionCreatedEventPartner
 
+    link: Nullable[CommissionCreatedEventLink]
+
     type: Optional[CommissionCreatedEventType] = None
 
     user_id: Annotated[OptionalNullable[str], pydantic.Field(alias="userId")] = UNSET
@@ -252,31 +315,28 @@ class CommissionCreatedEventData(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["type", "userId", "customer"]
-        nullable_fields = ["invoiceId", "description", "userId", "customer"]
-        null_default_fields = []
-
+        optional_fields = set(["type", "userId", "customer"])
+        nullable_fields = set(
+            ["invoiceId", "description", "userId", "customer", "link"]
+        )
         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
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m
 

dub/models/components/domainschema.py

@@ -45,30 +45,14 @@ class RegisteredDomain(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["autoRenewalDisabledAt"]
-        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)
-            ):
+            if val != UNSET_SENTINEL:
                 m[k] = val
 
         return m
@@ -156,44 +140,41 @@ class DomainSchema(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "verified",
-            "primary",
-            "archived",
-            "assetLinks",
-            "appleAppSiteAssociation",
-        ]
-        nullable_fields = [
-            "placeholder",
-            "expiredUrl",
-            "notFoundUrl",
-            "logo",
-            "assetLinks",
-            "appleAppSiteAssociation",
-            "registeredDomain",
-        ]
-        null_default_fields = ["assetLinks", "appleAppSiteAssociation"]
-
+        optional_fields = set(
+            ["verified", "primary", "archived", "assetLinks", "appleAppSiteAssociation"]
+        )
+        nullable_fields = set(
+            [
+                "placeholder",
+                "expiredUrl",
+                "notFoundUrl",
+                "logo",
+                "assetLinks",
+                "appleAppSiteAssociation",
+                "registeredDomain",
+            ]
+        )
+        null_default_fields = set(["assetLinks", "appleAppSiteAssociation"])
         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
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (
+                    self.__pydantic_fields_set__.intersection({n})
+                    or k in null_default_fields
+                )  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m

dub/models/components/folderschema.py

@@ -61,30 +61,29 @@ class FolderSchema(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["accessLevel"]
-        nullable_fields = ["description", "accessLevel"]
-        null_default_fields = ["accessLevel"]
-
+        optional_fields = set(["accessLevel"])
+        nullable_fields = set(["description", "accessLevel"])
+        null_default_fields = set(["accessLevel"])
         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
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (
+                    self.__pydantic_fields_set__.intersection({n})
+                    or k in null_default_fields
+                )  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m