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

dub/models/components/salecreatedevent.py

@@ -17,36 +17,42 @@ class SaleCreatedEventEvent(str, Enum):
 class SaleCreatedEventCustomerTypedDict(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 SaleCreatedEventCustomer(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."""
@@ -54,6 +60,11 @@ class SaleCreatedEventCustomer(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."""
 
@@ -65,33 +76,60 @@ class SaleCreatedEventCustomer(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)
-
-            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
 
@@ -147,31 +185,26 @@ class SaleCreatedEventClick(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["trigger"]
-        nullable_fields = ["trigger"]
-        null_default_fields = []
-
+        optional_fields = set(["trigger"])
+        nullable_fields = set(["trigger"])
         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
 
@@ -431,63 +464,55 @@ class SaleCreatedEventLink(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "testVariants",
-            "clicks",
-            "leads",
-            "conversions",
-            "sales",
-            "saleAmount",
-        ]
-        nullable_fields = [
-            "externalId",
-            "tenantId",
-            "programId",
-            "partnerId",
-            "expiredUrl",
-            "password",
-            "title",
-            "description",
-            "image",
-            "video",
-            "ios",
-            "android",
-            "geo",
-            "tags",
-            "folderId",
-            "comments",
-            "utm_source",
-            "utm_medium",
-            "utm_campaign",
-            "utm_term",
-            "utm_content",
-            "testVariants",
-            "userId",
-            "tagId",
-        ]
-        null_default_fields = []
-
+        optional_fields = set(
+            ["testVariants", "clicks", "leads", "conversions", "sales", "saleAmount"]
+        )
+        nullable_fields = set(
+            [
+                "externalId",
+                "tenantId",
+                "programId",
+                "partnerId",
+                "expiredUrl",
+                "password",
+                "title",
+                "description",
+                "image",
+                "video",
+                "ios",
+                "android",
+                "geo",
+                "tags",
+                "folderId",
+                "comments",
+                "utm_source",
+                "utm_medium",
+                "utm_campaign",
+                "utm_term",
+                "utm_content",
+                "testVariants",
+                "userId",
+                "tagId",
+            ]
+        )
         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
 
@@ -510,30 +535,14 @@ class Sale(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["invoiceId"]
-        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
@@ -598,31 +607,28 @@ class SaleCreatedEventPartner(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
 
@@ -654,31 +660,26 @@ class SaleCreatedEventData(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["partner", "metadata"]
-        nullable_fields = ["partner", "metadata"]
-        null_default_fields = []
-
+        optional_fields = set(["partner", "metadata"])
+        nullable_fields = set(["partner", "metadata"])
         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/errors/badrequest.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class Error(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class BadRequestData(BaseModel):
     error: Error

dub/models/errors/conflict.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class ConflictError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class ConflictData(BaseModel):
     error: ConflictError

dub/models/errors/forbidden.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class ForbiddenError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class ForbiddenData(BaseModel):
     error: ForbiddenError

dub/models/errors/internalservererror.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class InternalServerErrorError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class InternalServerErrorData(BaseModel):
     error: InternalServerErrorError

dub/models/errors/inviteexpired.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class InviteExpiredError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class InviteExpiredData(BaseModel):
     error: InviteExpiredError

dub/models/errors/notfound.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class NotFoundError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class NotFoundData(BaseModel):
     error: NotFoundError

dub/models/errors/ratelimitexceeded.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from dub.models.errors import DubError
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from enum import Enum
 import httpx
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -35,6 +36,22 @@ class RateLimitExceededError(BaseModel):
     doc_url: Optional[str] = None
     r"""A link to our documentation with more details about this error code"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["doc_url"])
+        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
+
 
 class RateLimitExceededData(BaseModel):
     error: RateLimitExceededError