dub 0.27.1__tar.gz → 0.27.3__tar.gz

{dub-0.27.1 → dub-0.27.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dub
-Version: 0.27.1
+Version: 0.27.3
 Summary: Python Client SDK Generated by Speakeasy
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -32,7 +32,7 @@ Learn more about the Dub.co Python SDK in the [official documentation](https://d
 <!-- Start Summary [summary] -->
 ## Summary
 
-Dub API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.
+Dub API: Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
@@ -331,6 +331,7 @@ asyncio.run(main())
 ### [partners](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md)
 
 * [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#create) - Create a partner
+* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#list) - List all partners
 * [create_link](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#create_link) - Create a link for a partner
 * [retrieve_links](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#retrieve_links) - Retrieve a partner's links.
 * [upsert_link](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#upsert_link) - Upsert a link for a partner

{dub-0.27.1 → dub-0.27.3}/README-PYPI.md

@@ -14,7 +14,7 @@ Learn more about the Dub.co Python SDK in the [official documentation](https://d
 <!-- Start Summary [summary] -->
 ## Summary
 
-Dub API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.
+Dub API: Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
@@ -313,6 +313,7 @@ asyncio.run(main())
 ### [partners](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md)
 
 * [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#create) - Create a partner
+* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#list) - List all partners
 * [create_link](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#create_link) - Create a link for a partner
 * [retrieve_links](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#retrieve_links) - Retrieve a partner's links.
 * [upsert_link](https://github.com/dubinc/dub-python/blob/master/docs/sdks/partners/README.md#upsert_link) - Upsert a link for a partner

{dub-0.27.1 → dub-0.27.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dub"
-version = "0.27.1"
+version = "0.27.3"
 description = "Python Client SDK Generated by Speakeasy"
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

{dub-0.27.1 → dub-0.27.3}/src/dub/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "dub"
-__version__: str = "0.27.1"
+__version__: str = "0.27.3"
 __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.672.0"
+__user_agent__: str = "speakeasy-sdk/python 0.27.3 2.672.0 0.0.1 dub"
 
 try:
     if __package__ is not None:

{dub-0.27.1 → dub-0.27.3}/src/dub/models/components/__init__.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING
 from importlib import import_module
+import builtins
 
 if TYPE_CHECKING:
     from .analyticsbrowsers import AnalyticsBrowsers, AnalyticsBrowsersTypedDict
@@ -51,6 +52,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 +159,7 @@ if TYPE_CHECKING:
         PartnerAnalyticsTopLinksTypedDict,
     )
     from .partnerenrolledevent import (
+        BannedReason,
         PartnerEnrolledEvent,
         PartnerEnrolledEventData,
         PartnerEnrolledEventDataTypedDict,
@@ -236,6 +251,7 @@ __all__ = [
     "AnalyticsTopUrlsTypedDict",
     "AnalyticsTriggers",
     "AnalyticsTriggersTypedDict",
+    "BannedReason",
     "City",
     "Click",
     "ClickEvent",
@@ -247,6 +263,15 @@ __all__ = [
     "ClickTypedDict",
     "Code",
     "Color",
+    "CommissionCreatedEvent",
+    "CommissionCreatedEventCustomer",
+    "CommissionCreatedEventCustomerTypedDict",
+    "CommissionCreatedEventData",
+    "CommissionCreatedEventDataTypedDict",
+    "CommissionCreatedEventEvent",
+    "CommissionCreatedEventStatus",
+    "CommissionCreatedEventType",
+    "CommissionCreatedEventTypedDict",
     "Continent",
     "ContinentCode",
     "CountryCode",
@@ -319,6 +344,7 @@ __all__ = [
     "LinkWebhookEventTestVariantsTypedDict",
     "LinkWebhookEventTypedDict",
     "One",
+    "Partner",
     "PartnerAnalyticsCount",
     "PartnerAnalyticsCountTypedDict",
     "PartnerAnalyticsTimeseries",
@@ -332,6 +358,7 @@ __all__ = [
     "PartnerEnrolledEventLink",
     "PartnerEnrolledEventLinkTypedDict",
     "PartnerEnrolledEventTypedDict",
+    "PartnerTypedDict",
     "PaymentProcessor",
     "Plan",
     "Region",
@@ -434,6 +461,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 +553,7 @@ _dynamic_imports: dict[str, str] = {
     "PartnerAnalyticsTimeseriesTypedDict": ".partneranalyticstimeseries",
     "PartnerAnalyticsTopLinks": ".partneranalyticstoplinks",
     "PartnerAnalyticsTopLinksTypedDict": ".partneranalyticstoplinks",
+    "BannedReason": ".partnerenrolledevent",
     "PartnerEnrolledEvent": ".partnerenrolledevent",
     "PartnerEnrolledEventData": ".partnerenrolledevent",
     "PartnerEnrolledEventDataTypedDict": ".partnerenrolledevent",
@@ -596,5 +635,5 @@ def __getattr__(attr_name: str) -> object:
 
 
 def __dir__():
-    lazy_attrs = list(_dynamic_imports.keys())
-    return sorted(lazy_attrs)
+    lazy_attrs = builtins.list(_dynamic_imports.keys())
+    return builtins.sorted(lazy_attrs)

{dub-0.27.1 → dub-0.27.3}/src/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-0.27.1 → dub-0.27.3}/src/dub/models/components/clickevent.py

@@ -29,6 +29,7 @@ class ClickTypedDict(TypedDict):
     referer_url: str
     qr: bool
     ip: str
+    trigger: NotRequired[Nullable[str]]
 
 
 class Click(BaseModel):
@@ -60,6 +61,38 @@ class Click(BaseModel):
 
     ip: str
 
+    trigger: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["trigger"]
+        nullable_fields = ["trigger"]
+        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 ClickEventGeoTypedDict(TypedDict):
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
@@ -871,8 +904,6 @@ class LinkTypedDict(TypedDict):
     geo: Nullable[ClickEventGeoTypedDict]
     r"""Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo"""
     public_stats: bool
-    tag_id: Nullable[str]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
     tags: Nullable[List[TagSchemaTypedDict]]
     r"""The tags assigned to the short link."""
     folder_id: Nullable[str]
@@ -903,18 +934,22 @@ class LinkTypedDict(TypedDict):
     last_clicked: str
     created_at: str
     updated_at: str
+    tag_id: Nullable[str]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
     project_id: str
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
     test_variants: NotRequired[Nullable[List[ClickEventTestVariantsTypedDict]]]
     r"""An array of A/B test URLs and the percentage of traffic to send to each URL."""
     clicks: NotRequired[float]
     r"""The number of clicks on the short link."""
     leads: NotRequired[float]
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+    conversions: NotRequired[float]
+    r"""The number of leads that converted to paying customers."""
     sales: NotRequired[float]
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
     sale_amount: NotRequired[float]
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
 
 class Link(BaseModel):
@@ -981,15 +1016,6 @@ class Link(BaseModel):
 
     public_stats: Annotated[bool, pydantic.Field(alias="publicStats")]
 
-    tag_id: Annotated[
-        Nullable[str],
-        pydantic.Field(
-            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
-            alias="tagId",
-        ),
-    ]
-    r"""The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead."""
-
     tags: Nullable[List[TagSchema]]
     r"""The tags assigned to the short link."""
 
@@ -1038,6 +1064,15 @@ class Link(BaseModel):
 
     updated_at: Annotated[str, pydantic.Field(alias="updatedAt")]
 
+    tag_id: Annotated[
+        Nullable[str],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.",
+            alias="tagId",
+        ),
+    ]
+    r"""Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link."""
+
     project_id: Annotated[
         str,
         pydantic.Field(
@@ -1045,7 +1080,7 @@ class Link(BaseModel):
             alias="projectId",
         ),
     ]
-    r"""The project ID of the short link. This field is deprecated – use `workspaceId` instead."""
+    r"""Deprecated: Use `workspaceId` instead. The project ID of the short link."""
 
     test_variants: Annotated[
         OptionalNullable[List[ClickEventTestVariants]],
@@ -1057,17 +1092,27 @@ class Link(BaseModel):
     r"""The number of clicks on the short link."""
 
     leads: Optional[float] = 0
-    r"""The number of leads the short links has generated."""
+    r"""The number of leads the short link has generated."""
+
+    conversions: Optional[float] = 0
+    r"""The number of leads that converted to paying customers."""
 
     sales: Optional[float] = 0
-    r"""The number of sales the short links has generated."""
+    r"""The total number of sales (includes recurring sales) generated by the short link."""
 
     sale_amount: Annotated[Optional[float], pydantic.Field(alias="saleAmount")] = 0
-    r"""The total dollar amount of sales the short links has generated (in cents)."""
+    r"""The total dollar value of sales (in cents) generated by the short link."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["testVariants", "clicks", "leads", "sales", "saleAmount"]
+        optional_fields = [
+            "testVariants",
+            "clicks",
+            "leads",
+            "conversions",
+            "sales",
+            "saleAmount",
+        ]
         nullable_fields = [
             "externalId",
             "tenantId",
@@ -1082,7 +1127,6 @@ class Link(BaseModel):
             "ios",
             "android",
             "geo",
-            "tagId",
             "tags",
             "folderId",
             "comments",
@@ -1095,6 +1139,7 @@ class Link(BaseModel):
             "testStartedAt",
             "testCompletedAt",
             "userId",
+            "tagId",
         ]
         null_default_fields = []
 
@@ -1129,31 +1174,31 @@ class ClickEventTypedDict(TypedDict):
     click: ClickTypedDict
     link: LinkTypedDict
     click_id: str
-    r"""Deprecated. Use `click.id` instead."""
+    r"""Deprecated: Use `click.id` instead."""
     link_id: str
-    r"""Deprecated. Use `link.id` instead."""
+    r"""Deprecated: Use `link.id` instead."""
     domain: str
-    r"""Deprecated. Use `link.domain` instead."""
+    r"""Deprecated: Use `link.domain` instead."""
     key: str
-    r"""Deprecated. Use `link.key` instead."""
+    r"""Deprecated: Use `link.key` instead."""
     url: str
-    r"""Deprecated. Use `click.url` instead."""
+    r"""Deprecated: Use `click.url` instead."""
     continent: str
-    r"""Deprecated. Use `click.continent` instead."""
+    r"""Deprecated: Use `click.continent` instead."""
     country: str
-    r"""Deprecated. Use `click.country` instead."""
+    r"""Deprecated: Use `click.country` instead."""
     city: str
-    r"""Deprecated. Use `click.city` instead."""
+    r"""Deprecated: Use `click.city` instead."""
     device: str
-    r"""Deprecated. Use `click.device` instead."""
+    r"""Deprecated: Use `click.device` instead."""
     browser: str
-    r"""Deprecated. Use `click.browser` instead."""
+    r"""Deprecated: Use `click.browser` instead."""
     os: str
-    r"""Deprecated. Use `click.os` instead."""
+    r"""Deprecated: Use `click.os` instead."""
     qr: float
-    r"""Deprecated. Use `click.qr` instead."""
+    r"""Deprecated: Use `click.qr` instead."""
     ip: str
-    r"""Deprecated. Use `click.ip` instead."""
+    r"""Deprecated: Use `click.ip` instead."""
 
 
 class ClickEvent(BaseModel):
@@ -1171,7 +1216,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.id` instead."""
+    r"""Deprecated: Use `click.id` instead."""
 
     link_id: Annotated[
         str,
@@ -1179,7 +1224,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.id` instead."""
+    r"""Deprecated: Use `link.id` instead."""
 
     domain: Annotated[
         str,
@@ -1187,7 +1232,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.domain` instead."""
+    r"""Deprecated: Use `link.domain` instead."""
 
     key: Annotated[
         str,
@@ -1195,7 +1240,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `link.key` instead."""
+    r"""Deprecated: Use `link.key` instead."""
 
     url: Annotated[
         str,
@@ -1203,7 +1248,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.url` instead."""
+    r"""Deprecated: Use `click.url` instead."""
 
     continent: Annotated[
         str,
@@ -1211,7 +1256,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.continent` instead."""
+    r"""Deprecated: Use `click.continent` instead."""
 
     country: Annotated[
         str,
@@ -1219,7 +1264,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.country` instead."""
+    r"""Deprecated: Use `click.country` instead."""
 
     city: Annotated[
         str,
@@ -1227,7 +1272,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.city` instead."""
+    r"""Deprecated: Use `click.city` instead."""
 
     device: Annotated[
         str,
@@ -1235,7 +1280,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.device` instead."""
+    r"""Deprecated: Use `click.device` instead."""
 
     browser: Annotated[
         str,
@@ -1243,7 +1288,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.browser` instead."""
+    r"""Deprecated: Use `click.browser` instead."""
 
     os: Annotated[
         str,
@@ -1251,7 +1296,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.os` instead."""
+    r"""Deprecated: Use `click.os` instead."""
 
     qr: Annotated[
         float,
@@ -1259,7 +1304,7 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.qr` instead."""
+    r"""Deprecated: Use `click.qr` instead."""
 
     ip: Annotated[
         str,
@@ -1267,4 +1312,4 @@ class ClickEvent(BaseModel):
             deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
         ),
     ]
-    r"""Deprecated. Use `click.ip` instead."""
+    r"""Deprecated: Use `click.ip` instead."""