growsurf-python 1.14.0__tar.gz → 1.15.0__tar.gz

growsurf_python-1.15.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.15.0"
+}

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.15.0](https://github.com/growsurf/growsurf-python/compare/v1.14.1...v1.15.0) (2026-10-19)
+
+
+### Features
+
+* support reward image icon keys ([2fa2b67](https://github.com/growsurf/growsurf-python/commit/2fa2b6723ddb7e2e225a85f4d8471e2e5b8fc2b3))
+* support reward image icon keys ([252a3db](https://github.com/growsurf/growsurf-python/commit/252a3dbe115bcfdc44000a7c3b8996309b965116))
+
+## [1.14.1](https://github.com/growsurf/growsurf-python/compare/v1.14.0...v1.14.1) (2026-10-18)
+
+
+### Bug Fixes
+
+* clarify participant deletion access and cleanup docs ([1abfb93](https://github.com/growsurf/growsurf-python/commit/1abfb937f5ca7c782d5238f47a1e37e543d0d473))
+* clarify participant deletion access and cleanup docs ([d6820d4](https://github.com/growsurf/growsurf-python/commit/d6820d4998dd88544ef571b09d883578cd19fcbf))
+
 ## [1.14.0](https://github.com/growsurf/growsurf-python/compare/v1.13.1...v1.14.0) (2026-10-15)
 
 

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.14.0
+Version: 1.15.0
 Summary: The official Python library for the growsurf API
 Project-URL: Homepage, https://growsurf.com/
 Project-URL: Repository, https://github.com/growsurf/growsurf-python

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "growsurf-python"
-version = "1.14.0"
+version = "1.15.0"
 description = "The official Python library for the growsurf API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "growsurf"
-__version__ = "1.14.0"  # x-release-please-version
+__version__ = "1.15.0"  # x-release-please-version

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/resources/campaign/participant.py

@@ -221,7 +221,7 @@ class ParticipantResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantDeleteResponse:
         """
-        Removes a participant by GrowSurf participant ID or email address.
+        Removes participant access immediately by GrowSurf participant ID or email address. Related record cleanup completes automatically. Do not repeat a successful deletion to finish cleanup.
 
         Args:
           extra_headers: Send extra headers
@@ -267,9 +267,7 @@ class ParticipantResource(SyncAPIResource):
         `participants` is a GrowSurf participant ID or an email address (mixed lists are
         allowed). Up to `200` entries per request — chunk larger lists across multiple
         calls. The response reports a per-row `status` for every submitted entry, so a
-        `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent
-        and removes the participants' referrals, rewards, commissions, and payout
-        records.
+        `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention.
 
         Args:
           participants: GrowSurf participant IDs and/or email addresses to delete. Mixed entries are
@@ -1500,7 +1498,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantDeleteResponse:
         """
-        Removes a participant by GrowSurf participant ID or email address.
+        Removes participant access immediately by GrowSurf participant ID or email address. Related record cleanup completes automatically. Do not repeat a successful deletion to finish cleanup.
 
         Args:
           extra_headers: Send extra headers
@@ -1546,9 +1544,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         `participants` is a GrowSurf participant ID or an email address (mixed lists are
         allowed). Up to `200` entries per request — chunk larger lists across multiple
         calls. The response reports a per-row `status` for every submitted entry, so a
-        `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent
-        and removes the participants' referrals, rewards, commissions, and payout
-        records.
+        `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention.
 
         Args:
           participants: GrowSurf participant IDs and/or email addresses to delete. Mixed entries are

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/resources/campaign/rewards.py

@@ -61,6 +61,33 @@ class RewardsResource(SyncAPIResource):
         description: str | Omit = omit,
         event: Literal["LEAD", "CONVERSION"] | Omit = omit,
         image_url: Optional[str] | Omit = omit,
+        image_icon_key: Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ]
+        | Omit = omit,
         is_unlimited: bool | Omit = omit,
         is_visible: bool | Omit = omit,
         limit: int | Omit = omit,
@@ -107,6 +134,11 @@ class RewardsResource(SyncAPIResource):
 
           image_url: An image URL for the reward.
 
+          image_icon_key: The starter icon shown for the reward, or `null` when `imageUrl` is your own
+              image. Participant pages draw this icon in your program's accent color. Also set
+              `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+              `imageUrl` without `imageIconKey` clears it.
+
           is_unlimited: Whether the reward can be earned an unlimited number of times. Defaults to
               `true`, except `MILESTONE` rewards, which can only be earned once.
 
@@ -159,6 +191,7 @@ class RewardsResource(SyncAPIResource):
                     "description": description,
                     "event": event,
                     "image_url": image_url,
+                    "image_icon_key": image_icon_key,
                     "is_unlimited": is_unlimited,
                     "is_visible": is_visible,
                     "limit": limit,
@@ -194,6 +227,33 @@ class RewardsResource(SyncAPIResource):
         description: str | Omit = omit,
         event: Literal["LEAD", "CONVERSION"] | Omit = omit,
         image_url: Optional[str] | Omit = omit,
+        image_icon_key: Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ]
+        | Omit = omit,
         is_unlimited: bool | Omit = omit,
         is_visible: bool | Omit = omit,
         limit: int | Omit = omit,
@@ -240,6 +300,11 @@ class RewardsResource(SyncAPIResource):
 
           image_url: An image URL for the reward.
 
+          image_icon_key: The starter icon shown for the reward, or `null` when `imageUrl` is your own
+              image. Participant pages draw this icon in your program's accent color. Also set
+              `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+              `imageUrl` without `imageIconKey` clears it.
+
           is_unlimited: Whether the reward can be earned an unlimited number of times. Defaults to
               `true`, except `MILESTONE` rewards, which can only be earned once.
 
@@ -295,6 +360,7 @@ class RewardsResource(SyncAPIResource):
                     "description": description,
                     "event": event,
                     "image_url": image_url,
+                    "image_icon_key": image_icon_key,
                     "is_unlimited": is_unlimited,
                     "is_visible": is_visible,
                     "limit": limit,
@@ -431,6 +497,33 @@ class AsyncRewardsResource(AsyncAPIResource):
         description: str | Omit = omit,
         event: Literal["LEAD", "CONVERSION"] | Omit = omit,
         image_url: Optional[str] | Omit = omit,
+        image_icon_key: Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ]
+        | Omit = omit,
         is_unlimited: bool | Omit = omit,
         is_visible: bool | Omit = omit,
         limit: int | Omit = omit,
@@ -477,6 +570,11 @@ class AsyncRewardsResource(AsyncAPIResource):
 
           image_url: An image URL for the reward.
 
+          image_icon_key: The starter icon shown for the reward, or `null` when `imageUrl` is your own
+              image. Participant pages draw this icon in your program's accent color. Also set
+              `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+              `imageUrl` without `imageIconKey` clears it.
+
           is_unlimited: Whether the reward can be earned an unlimited number of times. Defaults to
               `true`, except `MILESTONE` rewards, which can only be earned once.
 
@@ -529,6 +627,7 @@ class AsyncRewardsResource(AsyncAPIResource):
                     "description": description,
                     "event": event,
                     "image_url": image_url,
+                    "image_icon_key": image_icon_key,
                     "is_unlimited": is_unlimited,
                     "is_visible": is_visible,
                     "limit": limit,
@@ -564,6 +663,33 @@ class AsyncRewardsResource(AsyncAPIResource):
         description: str | Omit = omit,
         event: Literal["LEAD", "CONVERSION"] | Omit = omit,
         image_url: Optional[str] | Omit = omit,
+        image_icon_key: Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ]
+        | Omit = omit,
         is_unlimited: bool | Omit = omit,
         is_visible: bool | Omit = omit,
         limit: int | Omit = omit,
@@ -610,6 +736,11 @@ class AsyncRewardsResource(AsyncAPIResource):
 
           image_url: An image URL for the reward.
 
+          image_icon_key: The starter icon shown for the reward, or `null` when `imageUrl` is your own
+              image. Participant pages draw this icon in your program's accent color. Also set
+              `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+              `imageUrl` without `imageIconKey` clears it.
+
           is_unlimited: Whether the reward can be earned an unlimited number of times. Defaults to
               `true`, except `MILESTONE` rewards, which can only be earned once.
 
@@ -665,6 +796,7 @@ class AsyncRewardsResource(AsyncAPIResource):
                     "description": description,
                     "event": event,
                     "image_url": image_url,
+                    "image_icon_key": image_icon_key,
                     "is_unlimited": is_unlimited,
                     "is_visible": is_visible,
                     "limit": limit,

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/types/campaign/campaign.py

@@ -39,6 +39,34 @@ class Reward(BaseModel):
 
     image_url: Optional[str] = FieldInfo(alias="imageUrl", default=None)
 
+    image_icon_key: Optional[
+        Literal[
+            "GIFT_1",
+            "GIFT_2",
+            "GIFT_3",
+            "GIFT_4",
+            "GIFT_5",
+            "GIFT_6",
+            "GIFT_CARD",
+            "CASH",
+            "COIN",
+            "CARD",
+            "STAR_1",
+            "STAR_2",
+            "STAR_3",
+            "TROPHY",
+            "CROWN",
+            "SEAL",
+            "HEART_1",
+            "HEART_2",
+            "TAG",
+            "DIAMOND",
+            "CONFETTI",
+            "ROCKET",
+        ]
+    ] = FieldInfo(alias="imageIconKey", default=None)
+    """The starter icon shown for the reward, or `null` when `imageUrl` is your own image."""
+
     is_visible: Optional[bool] = FieldInfo(alias="isVisible", default=None)
     """Whether the reward is enabled.
 

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/types/campaign/reward.py

@@ -51,6 +51,34 @@ class Reward(BaseModel):
     image_url: Optional[str] = FieldInfo(alias="imageUrl", default=None)
     """The reward image URL."""
 
+    image_icon_key: Optional[
+        Literal[
+            "GIFT_1",
+            "GIFT_2",
+            "GIFT_3",
+            "GIFT_4",
+            "GIFT_5",
+            "GIFT_6",
+            "GIFT_CARD",
+            "CASH",
+            "COIN",
+            "CARD",
+            "STAR_1",
+            "STAR_2",
+            "STAR_3",
+            "TROPHY",
+            "CROWN",
+            "SEAL",
+            "HEART_1",
+            "HEART_2",
+            "TAG",
+            "DIAMOND",
+            "CONFETTI",
+            "ROCKET",
+        ]
+    ] = FieldInfo(alias="imageIconKey", default=None)
+    """The starter icon shown for the reward, or `null` when `imageUrl` is your own image."""
+
     is_visible: Optional[bool] = FieldInfo(alias="isVisible", default=None)
     """Whether the reward is enabled.
 

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/types/campaign/reward_create_params.py

@@ -43,6 +43,42 @@ class RewardCreateParams(TypedDict, total=False):
     image_url: Annotated[Optional[str], PropertyInfo(alias="imageUrl")]
     """An image URL for the reward."""
 
+    image_icon_key: Annotated[
+        Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ],
+        PropertyInfo(alias="imageIconKey"),
+    ]
+    """The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
+
+    Participant pages draw this icon in your program's accent color. Also set
+    `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+    `imageUrl` without `imageIconKey` clears it.
+    """
+
     is_unlimited: Annotated[bool, PropertyInfo(alias="isUnlimited")]
     """Whether the reward can be earned an unlimited number of times.
 

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/src/growsurf/types/campaign/reward_update_params.py

@@ -42,6 +42,42 @@ class RewardUpdateParams(TypedDict, total=False):
     image_url: Annotated[Optional[str], PropertyInfo(alias="imageUrl")]
     """An image URL for the reward."""
 
+    image_icon_key: Annotated[
+        Optional[
+            Literal[
+                "GIFT_1",
+                "GIFT_2",
+                "GIFT_3",
+                "GIFT_4",
+                "GIFT_5",
+                "GIFT_6",
+                "GIFT_CARD",
+                "CASH",
+                "COIN",
+                "CARD",
+                "STAR_1",
+                "STAR_2",
+                "STAR_3",
+                "TROPHY",
+                "CROWN",
+                "SEAL",
+                "HEART_1",
+                "HEART_2",
+                "TAG",
+                "DIAMOND",
+                "CONFETTI",
+                "ROCKET",
+            ]
+        ],
+        PropertyInfo(alias="imageIconKey"),
+    ]
+    """The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
+
+    Participant pages draw this icon in your program's accent color. Also set
+    `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+    `imageUrl` without `imageIconKey` clears it.
+    """
+
     is_unlimited: Annotated[bool, PropertyInfo(alias="isUnlimited")]
     """Whether the reward can be earned an unlimited number of times.
 

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/tests/api_resources/campaign/test_rewards.py

@@ -64,6 +64,7 @@ class TestRewards:
             coupon_code="couponCode",
             description="description",
             image_url="imageUrl",
+            image_icon_key="GIFT_1",
             is_unlimited=True,
             is_visible=True,
             limit=0,
@@ -136,6 +137,7 @@ class TestRewards:
             coupon_code="couponCode",
             description="description",
             image_url="imageUrl",
+            image_icon_key="GIFT_1",
             is_unlimited=True,
             is_visible=True,
             limit=0,
@@ -314,6 +316,7 @@ class TestAsyncRewards:
             coupon_code="couponCode",
             description="description",
             image_url="imageUrl",
+            image_icon_key="GIFT_1",
             is_unlimited=True,
             is_visible=True,
             limit=0,
@@ -386,6 +389,7 @@ class TestAsyncRewards:
             coupon_code="couponCode",
             description="description",
             image_url="imageUrl",
+            image_icon_key="GIFT_1",
             is_unlimited=True,
             is_visible=True,
             limit=0,

{growsurf_python-1.14.0 → growsurf_python-1.15.0}/uv.lock

@@ -401,7 +401,7 @@ wheels = [
 
 [[package]]
 name = "growsurf-python"
-version = "1.11.0"
+version = "1.14.1"
 source = { editable = "." }
 dependencies = [
     { name = "anyio" },

growsurf_python-1.14.0/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "1.14.0"
-}