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

dub/models/operations/getlinkinfo.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 dub.utils import FieldMetadata, QueryParamMetadata
 import pydantic
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -41,3 +42,19 @@ class GetLinkInfoRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
     r"""This is the ID of the link in the your database."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["domain", "key", "linkId", "externalId"])
+        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/operations/getlinks.py

@@ -2,10 +2,11 @@
 
 from __future__ import annotations
 from dub.models.components import linkschema as components_linkschema
-from dub.types import BaseModel
+from dub.types import BaseModel, UNSET_SENTINEL
 from dub.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 import pydantic
+from pydantic import model_serializer
 from typing import Callable, List, Optional, Union
 from typing_extensions import (
     Annotated,
@@ -199,6 +200,40 @@ class GetLinksRequest(BaseModel):
     ] = 100
     r"""The number of items per page."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "domain",
+                "tagId",
+                "tagIds",
+                "tagNames",
+                "folderId",
+                "search",
+                "userId",
+                "tenantId",
+                "showArchived",
+                "withTags",
+                "sortBy",
+                "sortOrder",
+                "sort",
+                "page",
+                "pageSize",
+            ]
+        )
+        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 GetLinksResponseTypedDict(TypedDict):
     result: List[components_linkschema.LinkSchemaTypedDict]

dub/models/operations/getlinkscount.py

@@ -1,10 +1,11 @@
 """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 dub.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 import pydantic
+from pydantic import model_serializer
 from typing import List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
@@ -157,3 +158,33 @@ class GetLinksCountRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
     r"""The field to group the links by."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "domain",
+                "tagId",
+                "tagIds",
+                "tagNames",
+                "folderId",
+                "search",
+                "userId",
+                "tenantId",
+                "showArchived",
+                "withTags",
+                "groupBy",
+            ]
+        )
+        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/operations/getqrcode.py

@@ -1,10 +1,11 @@
 """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 dub.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 import pydantic
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -96,3 +97,30 @@ class GetQRCodeRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = True
     r"""DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "logo",
+                "size",
+                "level",
+                "fgColor",
+                "bgColor",
+                "hideLogo",
+                "margin",
+                "includeMargin",
+            ]
+        )
+        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/operations/gettags.py

@@ -1,10 +1,11 @@
 """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 dub.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 import pydantic
+from pydantic import model_serializer
 from typing import List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
@@ -85,3 +86,21 @@ class GetTagsRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = 100
     r"""The number of items per page."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["sortBy", "sortOrder", "search", "ids", "page", "pageSize"]
+        )
+        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/operations/listbountysubmissions.py

@@ -35,6 +35,7 @@ class ListBountySubmissionsQueryParamSortOrder(str, Enum):
 
 class ListBountySubmissionsRequestTypedDict(TypedDict):
     bounty_id: str
+    r"""The ID of the bounty"""
     status: NotRequired[ListBountySubmissionsQueryParamStatus]
     r"""The status of the submissions to list."""
     group_id: NotRequired[str]
@@ -57,6 +58,7 @@ class ListBountySubmissionsRequest(BaseModel):
         pydantic.Field(alias="bountyId"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
+    r"""The ID of the bounty"""
 
     status: Annotated[
         Optional[ListBountySubmissionsQueryParamStatus],
@@ -105,22 +107,56 @@ class ListBountySubmissionsRequest(BaseModel):
     ] = 100
     r"""The number of items per page."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "status",
+                "groupId",
+                "partnerId",
+                "sortBy",
+                "sortOrder",
+                "page",
+                "pageSize",
+            ]
+        )
+        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 FilesTypedDict(TypedDict):
     url: str
+    r"""The URL of the uploaded file."""
     file_name: str
+    r"""The original file name."""
     size: float
+    r"""The file size in bytes."""
 
 
 class Files(BaseModel):
     url: str
+    r"""The URL of the uploaded file."""
 
     file_name: Annotated[str, pydantic.Field(alias="fileName")]
+    r"""The original file name."""
 
     size: float
+    r"""The file size in bytes."""
 
 
 class ListBountySubmissionsStatus(str, Enum):
+    r"""The status of the submission"""
+
     DRAFT = "draft"
     SUBMITTED = "submitted"
     APPROVED = "approved"
@@ -129,84 +165,85 @@ class ListBountySubmissionsStatus(str, Enum):
 
 class ListBountySubmissionsResponseBodyTypedDict(TypedDict):
     id: str
+    r"""The ID of the bounty submission"""
     bounty_id: str
+    r"""The ID of the bounty"""
     partner_id: str
+    r"""The ID of the partner"""
     description: Nullable[str]
+    r"""The description of the submission"""
     urls: Nullable[List[str]]
+    r"""The URLs submitted for the submission"""
     files: Nullable[List[FilesTypedDict]]
+    r"""The files uploaded for the submission"""
     status: ListBountySubmissionsStatus
+    r"""The status of the submission"""
     performance_count: Nullable[float]
+    r"""The performance count of the submission"""
     created_at: str
+    r"""The date and time the submission was created"""
     completed_at: Nullable[str]
+    r"""The date and time the submission was completed"""
     reviewed_at: Nullable[str]
+    r"""The date and time the submission was reviewed"""
     rejection_reason: Nullable[str]
+    r"""The reason for rejecting the submission"""
     rejection_note: Nullable[str]
+    r"""The note for rejecting the submission"""
 
 
 class ListBountySubmissionsResponseBody(BaseModel):
     id: str
+    r"""The ID of the bounty submission"""
 
     bounty_id: Annotated[str, pydantic.Field(alias="bountyId")]
+    r"""The ID of the bounty"""
 
     partner_id: Annotated[str, pydantic.Field(alias="partnerId")]
+    r"""The ID of the partner"""
 
     description: Nullable[str]
+    r"""The description of the submission"""
 
     urls: Nullable[List[str]]
+    r"""The URLs submitted for the submission"""
 
     files: Nullable[List[Files]]
+    r"""The files uploaded for the submission"""
 
     status: ListBountySubmissionsStatus
+    r"""The status of the submission"""
 
     performance_count: Annotated[
         Nullable[float], pydantic.Field(alias="performanceCount")
     ]
+    r"""The performance count of the submission"""
 
     created_at: Annotated[str, pydantic.Field(alias="createdAt")]
+    r"""The date and time the submission was created"""
 
     completed_at: Annotated[Nullable[str], pydantic.Field(alias="completedAt")]
+    r"""The date and time the submission was completed"""
 
     reviewed_at: Annotated[Nullable[str], pydantic.Field(alias="reviewedAt")]
+    r"""The date and time the submission was reviewed"""
 
     rejection_reason: Annotated[Nullable[str], pydantic.Field(alias="rejectionReason")]
+    r"""The reason for rejecting the submission"""
 
     rejection_note: Annotated[Nullable[str], pydantic.Field(alias="rejectionNote")]
+    r"""The note for rejecting the submission"""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = []
-        nullable_fields = [
-            "description",
-            "urls",
-            "files",
-            "performanceCount",
-            "completedAt",
-            "reviewedAt",
-            "rejectionReason",
-            "rejectionNote",
-        ]
-        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/listcommissions.py

@@ -194,6 +194,41 @@ class ListCommissionsRequest(BaseModel):
     ] = 100
     r"""The number of items per page."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "type",
+                "customerId",
+                "payoutId",
+                "partnerId",
+                "tenantId",
+                "groupId",
+                "invoiceId",
+                "status",
+                "sortBy",
+                "sortOrder",
+                "interval",
+                "start",
+                "end",
+                "timezone",
+                "page",
+                "pageSize",
+            ]
+        )
+        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 ListCommissionsType(str, Enum):
     CLICK = "click"
@@ -255,31 +290,28 @@ class ListCommissionsPartner(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
 
@@ -287,36 +319,42 @@ class ListCommissionsPartner(BaseModel):
 class ListCommissionsCustomerTypedDict(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 ListCommissionsCustomer(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."""
@@ -324,6 +362,11 @@ class ListCommissionsCustomer(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."""
 
@@ -335,33 +378,60 @@ class ListCommissionsCustomer(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
 
@@ -418,30 +488,25 @@ class ListCommissionsResponseBody(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