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

dub/models/operations/tracklead.py

@@ -76,44 +76,47 @@ class TrackLeadRequestBody(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "customerName",
-            "customerEmail",
-            "customerAvatar",
-            "mode",
-            "eventQuantity",
-            "metadata",
-        ]
-        nullable_fields = [
-            "customerName",
-            "customerEmail",
-            "customerAvatar",
-            "eventQuantity",
-            "metadata",
-        ]
-        null_default_fields = ["customerName", "customerEmail", "customerAvatar"]
-
+        optional_fields = set(
+            [
+                "customerName",
+                "customerEmail",
+                "customerAvatar",
+                "mode",
+                "eventQuantity",
+                "metadata",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "customerName",
+                "customerEmail",
+                "customerAvatar",
+                "eventQuantity",
+                "metadata",
+            ]
+        )
+        null_default_fields = set(["customerName", "customerEmail", "customerAvatar"])
         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
 
@@ -177,30 +180,14 @@ class Link(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["partnerId", "programId", "tenantId", "externalId"]
-        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
@@ -224,30 +211,14 @@ class Customer(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["name", "email", "avatar", "externalId"]
-        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
@@ -272,30 +243,14 @@ class TrackLeadResponseBody(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["link"]
-        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

dub/models/operations/tracksale.py

@@ -98,56 +98,61 @@ class TrackSaleRequestBody(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "currency",
-            "eventName",
-            "paymentProcessor",
-            "invoiceId",
-            "metadata",
-            "leadEventName",
-            "clickId",
-            "customerName",
-            "customerEmail",
-            "customerAvatar",
-        ]
-        nullable_fields = [
-            "invoiceId",
-            "metadata",
-            "leadEventName",
-            "clickId",
-            "customerName",
-            "customerEmail",
-            "customerAvatar",
-        ]
-        null_default_fields = [
-            "invoiceId",
-            "leadEventName",
-            "customerName",
-            "customerEmail",
-            "customerAvatar",
-        ]
-
+        optional_fields = set(
+            [
+                "currency",
+                "eventName",
+                "paymentProcessor",
+                "invoiceId",
+                "metadata",
+                "leadEventName",
+                "clickId",
+                "customerName",
+                "customerEmail",
+                "customerAvatar",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "invoiceId",
+                "metadata",
+                "leadEventName",
+                "clickId",
+                "customerName",
+                "customerEmail",
+                "customerAvatar",
+            ]
+        )
+        null_default_fields = set(
+            [
+                "invoiceId",
+                "leadEventName",
+                "customerName",
+                "customerEmail",
+                "customerAvatar",
+            ]
+        )
         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
 
@@ -173,30 +178,14 @@ class TrackSaleCustomer(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["name", "email", "avatar", "externalId"]
-        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
@@ -223,30 +212,14 @@ class Sale(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["invoiceId", "metadata"]
-        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
@@ -271,30 +244,14 @@ class TrackSaleResponseBody(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = ["customer", "sale"]
-        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

dub/models/operations/updatecommission.py

@@ -45,6 +45,22 @@ class UpdateCommissionRequestBody(BaseModel):
     status: Optional[Status] = None
     r"""Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["amount", "modifyAmount", "currency", "status"])
+        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 UpdateCommissionRequestTypedDict(TypedDict):
     id: str
@@ -63,6 +79,22 @@ class UpdateCommissionRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["RequestBody"])
+        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 UpdateCommissionType(str, Enum):
     CLICK = "click"
@@ -124,31 +156,28 @@ class UpdateCommissionPartner(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
 
@@ -156,36 +185,42 @@ class UpdateCommissionPartner(BaseModel):
 class UpdateCommissionCustomerTypedDict(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 UpdateCommissionCustomer(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."""
@@ -193,6 +228,11 @@ class UpdateCommissionCustomer(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."""
 
@@ -204,33 +244,60 @@ class UpdateCommissionCustomer(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
 
@@ -291,30 +358,25 @@ class UpdateCommissionResponseBody(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"])
         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