growsurf-python 1.8.0__tar.gz → 1.9.0__tar.gz

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

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

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [1.9.0](https://github.com/growsurf/growsurf-python/compare/v1.8.0...v1.9.0) (2026-09-21)
+
+
+### Features
+
+* **api:** add referral-flow screenshot capture and participant leadCount ([609e999](https://github.com/growsurf/growsurf-python/commit/609e99910a61e62eb764c3ea52fd880d3b7cdabf))
+
+
+### Chores
+
+* merge origin/main ([7c2e7cc](https://github.com/growsurf/growsurf-python/commit/7c2e7cc12f1bb7ce33db786b7e75450c74ebae37))
+
 ## [1.8.0](https://github.com/growsurf/growsurf-python/compare/v1.7.1...v1.8.0) (2026-09-19)
 
 

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.8.0
+Version: 1.9.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.8.0 → growsurf_python-1.9.0}/api.md

@@ -52,6 +52,8 @@ from growsurf.types import (
     CampaignListResponse,
     CampaignCreateMobileParticipantTokenResponse,
     CampaignRetrieveAnalyticsResponse,
+    ReferralFlowScreenshot,
+    ReferralFlowScreenshotsResponse,
 )
 ```
 
@@ -63,6 +65,7 @@ Methods:
 - <code title="get /campaigns">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list</a>() -> <a href="./src/growsurf/types/campaign_list_response.py">CampaignListResponse</a></code>
 - <code title="post /campaign/{id}/clone">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">clone</a>(id) -> <a href="./src/growsurf/types/campaign/campaign.py">Campaign</a></code>
 - <code title="post /campaign/{id}/mobile-participant-token">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">create_mobile_participant_token</a>(id, \*\*<a href="src/growsurf/types/campaign_create_mobile_participant_token_params.py">params</a>) -> <a href="./src/growsurf/types/campaign_create_mobile_participant_token_response.py">CampaignCreateMobileParticipantTokenResponse</a></code>
+- <code title="post /campaign/{id}/referral-flow-screenshots">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">capture_referral_flow_screenshots</a>(id) -> <a href="./src/growsurf/types/referral_flow_screenshots_response.py">ReferralFlowScreenshotsResponse</a></code>
 - <code title="get /campaign/{id}/commissions">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_commissions</a>(id, \*\*<a href="src/growsurf/types/campaign_list_commissions_params.py">params</a>) -> <a href="./src/growsurf/types/participant_commission_list.py">ParticipantCommissionList</a></code>
 - <code title="get /campaign/{id}/leaderboard">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_leaderboard</a>(id, \*\*<a href="src/growsurf/types/campaign_list_leaderboard_params.py">params</a>) -> <a href="./src/growsurf/types/participant_list.py">ParticipantList</a></code>
 - <code title="get /campaign/{id}/participants">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_participants</a>(id, \*\*<a href="src/growsurf/types/campaign_list_participants_params.py">params</a>) -> <a href="./src/growsurf/types/participant_list.py">ParticipantList</a></code>

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/pyproject.toml

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

{growsurf_python-1.8.0 → growsurf_python-1.9.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.8.0"  # x-release-please-version
+__version__ = "1.9.0"  # x-release-please-version

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/src/growsurf/resources/campaign/campaign.py

@@ -133,6 +133,7 @@ from ...types.participant_payout_list import ParticipantPayoutList
 from ...types.campaign.referral_status import ReferralStatus
 from ...types.participant_commission_list import ParticipantCommissionList
 from ...types.affiliate_invite_list_response import AffiliateInviteListResponse
+from ...types.referral_flow_screenshots_response import ReferralFlowScreenshotsResponse
 from ...types.affiliate_application_list_response import AffiliateApplicationListResponse
 from ...types.campaign_retrieve_analytics_response import CampaignRetrieveAnalyticsResponse
 from ...types.campaign_activation_analytics_response import CampaignActivationAnalyticsResponse
@@ -500,6 +501,45 @@ class CampaignResource(SyncAPIResource):
             cast_to=CampaignCreateMobileParticipantTokenResponse,
         )
 
+    def capture_referral_flow_screenshots(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ReferralFlowScreenshotsResponse:
+        """
+        Renders the program's current saved configuration into two preview images: the
+        referrer window a participant sees, and the referred-friend experience. Use them
+        to show a person what the draft looks like before anything launches. The images
+        render GrowSurf's own preview, not the program's installed website, so they do
+        not prove an installation. Each `url` is private and expires; capture again when
+        you need a fresh view. Only the account owner's credential can capture
+        screenshots, and the endpoint takes no request body.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._post(
+            path_template("/campaign/{id}/referral-flow-screenshots", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ReferralFlowScreenshotsResponse,
+        )
+
     def list_commissions(
         self,
         id: str,
@@ -1687,6 +1727,45 @@ class AsyncCampaignResource(AsyncAPIResource):
             cast_to=CampaignCreateMobileParticipantTokenResponse,
         )
 
+    async def capture_referral_flow_screenshots(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ReferralFlowScreenshotsResponse:
+        """
+        Renders the program's current saved configuration into two preview images: the
+        referrer window a participant sees, and the referred-friend experience. Use them
+        to show a person what the draft looks like before anything launches. The images
+        render GrowSurf's own preview, not the program's installed website, so they do
+        not prove an installation. Each `url` is private and expires; capture again when
+        you need a fresh view. Only the account owner's credential can capture
+        screenshots, and the endpoint takes no request body.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._post(
+            path_template("/campaign/{id}/referral-flow-screenshots", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ReferralFlowScreenshotsResponse,
+        )
+
     async def list_commissions(
         self,
         id: str,
@@ -2537,6 +2616,9 @@ class CampaignResourceWithRawResponse:
         self.create_mobile_participant_token = to_raw_response_wrapper(
             campaign.create_mobile_participant_token,
         )
+        self.capture_referral_flow_screenshots = to_raw_response_wrapper(
+            campaign.capture_referral_flow_screenshots,
+        )
         self.list_commissions = to_raw_response_wrapper(
             campaign.list_commissions,
         )
@@ -2656,6 +2738,9 @@ class AsyncCampaignResourceWithRawResponse:
         self.create_mobile_participant_token = async_to_raw_response_wrapper(
             campaign.create_mobile_participant_token,
         )
+        self.capture_referral_flow_screenshots = async_to_raw_response_wrapper(
+            campaign.capture_referral_flow_screenshots,
+        )
         self.list_commissions = async_to_raw_response_wrapper(
             campaign.list_commissions,
         )
@@ -2775,6 +2860,9 @@ class CampaignResourceWithStreamingResponse:
         self.create_mobile_participant_token = to_streamed_response_wrapper(
             campaign.create_mobile_participant_token,
         )
+        self.capture_referral_flow_screenshots = to_streamed_response_wrapper(
+            campaign.capture_referral_flow_screenshots,
+        )
         self.list_commissions = to_streamed_response_wrapper(
             campaign.list_commissions,
         )
@@ -2894,6 +2982,9 @@ class AsyncCampaignResourceWithStreamingResponse:
         self.create_mobile_participant_token = async_to_streamed_response_wrapper(
             campaign.create_mobile_participant_token,
         )
+        self.capture_referral_flow_screenshots = async_to_streamed_response_wrapper(
+            campaign.capture_referral_flow_screenshots,
+        )
         self.list_commissions = async_to_streamed_response_wrapper(
             campaign.list_commissions,
         )

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/src/growsurf/types/__init__.py

@@ -23,6 +23,7 @@ from .campaign_update_params import CampaignUpdateParams as CampaignUpdateParams
 from .create_account_response import CreateAccountResponse as CreateAccountResponse
 from .participant_payout_list import ParticipantPayoutList as ParticipantPayoutList
 from .rotate_api_key_response import RotateApiKeyResponse as RotateApiKeyResponse
+from .referral_flow_screenshot import ReferralFlowScreenshot as ReferralFlowScreenshot
 from .participant_commission_list import ParticipantCommissionList as ParticipantCommissionList
 from .verification_email_response import VerificationEmailResponse as VerificationEmailResponse
 from .affiliate_application_answer import AffiliateApplicationAnswer as AffiliateApplicationAnswer
@@ -35,6 +36,7 @@ from .campaign_list_commissions_params import CampaignListCommissionsParams as C
 from .campaign_list_leaderboard_params import CampaignListLeaderboardParams as CampaignListLeaderboardParams
 from .campaign_list_participants_params import CampaignListParticipantsParams as CampaignListParticipantsParams
 from .campaign_retrieve_analytics_params import CampaignRetrieveAnalyticsParams as CampaignRetrieveAnalyticsParams
+from .referral_flow_screenshots_response import ReferralFlowScreenshotsResponse as ReferralFlowScreenshotsResponse
 from .affiliate_application_list_response import AffiliateApplicationListResponse as AffiliateApplicationListResponse
 from .campaign_retrieve_analytics_response import CampaignRetrieveAnalyticsResponse as CampaignRetrieveAnalyticsResponse
 from .campaign_activation_analytics_response import (

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/src/growsurf/types/campaign/participant.py

@@ -49,6 +49,12 @@ class Referrer(BaseModel):
 
     last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
 
+    lead_count: Optional[int] = FieldInfo(alias="leadCount", default=None)
+    """
+    The number of pending referrals the participant made that have not converted
+    into successful referrals yet.
+    """
+
     metadata: Optional[Dict[str, object]] = None
     """Shallow custom metadata object."""
 
@@ -145,6 +151,12 @@ class Participant(BaseModel):
 
     last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
 
+    lead_count: Optional[int] = FieldInfo(alias="leadCount", default=None)
+    """
+    The number of pending referrals the participant made that have not converted
+    into successful referrals yet.
+    """
+
     metadata: Optional[Dict[str, object]] = None
     """Shallow custom metadata object."""
 

growsurf_python-1.9.0/src/growsurf/types/referral_flow_screenshot.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ReferralFlowScreenshot"]
+
+
+class ReferralFlowScreenshot(BaseModel):
+    view: Literal["referrer", "referredFriend"]
+    """Which side of the referral flow the image shows."""
+
+    label: str
+    """Short human-readable name for the view, such as `Referrer window`."""
+
+    url: str
+    """Private URL of the image. It stops working at `expiresAt`."""
+
+    expires_at: datetime = FieldInfo(alias="expiresAt")
+    """ISO 8601 time after which `url` no longer resolves."""
+
+    width: int
+    """Image width in pixels."""
+
+    height: int
+    """Image height in pixels."""
+
+    content_type: str = FieldInfo(alias="contentType")
+    """MIME type of the image."""

growsurf_python-1.9.0/src/growsurf/types/referral_flow_screenshots_response.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .referral_flow_screenshot import ReferralFlowScreenshot
+
+__all__ = ["ReferralFlowScreenshotsResponse"]
+
+
+class ReferralFlowScreenshotsResponse(BaseModel):
+    generated_at: datetime = FieldInfo(alias="generatedAt")
+    """ISO 8601 time the images were rendered."""
+
+    expires_at: datetime = FieldInfo(alias="expiresAt")
+    """ISO 8601 time after which every `url` in `screenshots` stops working."""
+
+    screenshots: List[ReferralFlowScreenshot]
+    """One entry per view, in referrer then referred-friend order."""

{growsurf_python-1.8.0 → growsurf_python-1.9.0}/tests/api_resources/test_campaign.py

@@ -20,6 +20,7 @@ from growsurf.types import (
     ParticipantPayoutList,
     ParticipantCommissionList,
     AffiliateInviteListResponse,
+    ReferralFlowScreenshotsResponse,
     AffiliateApplicationListResponse,
     CampaignRetrieveAnalyticsResponse,
     CampaignCreateMobileParticipantTokenResponse,
@@ -362,6 +363,48 @@ class TestCampaign:
                 email="dev@stainless.com",
             )
 
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_capture_referral_flow_screenshots(self, client: Growsurf) -> None:
+        campaign = client.campaign.capture_referral_flow_screenshots(
+            "id",
+        )
+        assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_raw_response_capture_referral_flow_screenshots(self, client: Growsurf) -> None:
+        response = client.campaign.with_raw_response.capture_referral_flow_screenshots(
+            "id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        campaign = response.parse()
+        assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_streaming_response_capture_referral_flow_screenshots(self, client: Growsurf) -> None:
+        with client.campaign.with_streaming_response.capture_referral_flow_screenshots(
+            "id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            campaign = response.parse()
+            assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_path_params_capture_referral_flow_screenshots(self, client: Growsurf) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.campaign.with_raw_response.capture_referral_flow_screenshots(
+                "",
+            )
+
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_method_list_commissions(self, client: Growsurf) -> None:
@@ -1384,6 +1427,48 @@ class TestAsyncCampaign:
                 email="dev@stainless.com",
             )
 
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_capture_referral_flow_screenshots(self, async_client: AsyncGrowsurf) -> None:
+        campaign = await async_client.campaign.capture_referral_flow_screenshots(
+            "id",
+        )
+        assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_raw_response_capture_referral_flow_screenshots(self, async_client: AsyncGrowsurf) -> None:
+        response = await async_client.campaign.with_raw_response.capture_referral_flow_screenshots(
+            "id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        campaign = await response.parse()
+        assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_streaming_response_capture_referral_flow_screenshots(self, async_client: AsyncGrowsurf) -> None:
+        async with async_client.campaign.with_streaming_response.capture_referral_flow_screenshots(
+            "id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            campaign = await response.parse()
+            assert_matches_type(ReferralFlowScreenshotsResponse, campaign, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_path_params_capture_referral_flow_screenshots(self, async_client: AsyncGrowsurf) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            await async_client.campaign.with_raw_response.capture_referral_flow_screenshots(
+                "",
+            )
+
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_method_list_commissions(self, async_client: AsyncGrowsurf) -> None:

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

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