growsurf-python 1.8.0__py3-none-any.whl → 1.9.0__py3-none-any.whl

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/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/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/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/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/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.dist-info → growsurf_python-1.9.0.dist-info}/METADATA

@@ -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.dist-info → growsurf_python-1.9.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ growsurf/_resource.py,sha256=oeDA0FL2ottIchoUi86M_8eUqmtrGQLYTgfKYEzrsWg,1112
 growsurf/_response.py,sha256=RTZ8t27W4S6ExkCjzCg4HbcDUTCdOMgiheiMAuAxgu4,28937
 growsurf/_streaming.py,sha256=9aJ_V6JtddntWCon2Cq_MOLMnySnhc7wuqeZx7sUtKU,10558
 growsurf/_types.py,sha256=r8hAVihrutiLUToaJhSDys9T9sMc8BMy2qUrr3W_8Wo,7751
-growsurf/_version.py,sha256=O36DV_DBZKjiTb0-a5hQWu4ZXF0b5IR9k9KMxihKrZY,160
+growsurf/_version.py,sha256=4WKOTnZ8FcparwmWKremivwBlS3DllnUQ3l_1PnqSoU,160
 growsurf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 growsurf/_utils/__init__.py,sha256=nQq-iFa5YxTaWySaLigatew5rHgTR0M75FNYm4mrO1s,2313
 growsurf/_utils/_compat.py,sha256=33246eDcl3pwL6kWsEhVuT4Akrd8gZEW9LPTm465ohk,1231
@@ -32,7 +32,7 @@ growsurf/resources/__init__.py,sha256=RYj6vjnPpErdBftiCuJtbwqGAnll4jXw6sg4qh6o98
 growsurf/resources/account.py,sha256=C07rN77026gPHHb0U8y8qlvvluK2ZljUfygztbxxO0A,10173
 growsurf/resources/team.py,sha256=q3KpMg6Kflk3LDCRt0bUQeo2LiEb3Ih-8iHjZ7tRvjM,14781
 growsurf/resources/campaign/__init__.py,sha256=Pz3ef3fSs5bMyAJMwa_IIdVGkfYI-QV0Z1AeSraaDew,5984
-growsurf/resources/campaign/campaign.py,sha256=RsP44J-phS2mWnEGT2vzWmy5Ct3PfsWG664NZ6DroJE,125287
+growsurf/resources/campaign/campaign.py,sha256=s7jg6ceNJuheXCsStL0ahPKYNq_iERbqkAQbdgnVXjI,129771
 growsurf/resources/campaign/commission.py,sha256=Li8L2l8xRh4EXa_oD7R9RJ6m4xaA4pmt9gXTxib2Fkk,10426
 growsurf/resources/campaign/design.py,sha256=qw5Uif4dXZX5WxeyS-Sr8b91aVpo1dMhMHwUu-whbEQ,11838
 growsurf/resources/campaign/emails.py,sha256=kECJC5jUUAw5RmarBfOAktGkXmg-5DFKTwcHN4ygVMc,10816
@@ -44,7 +44,7 @@ growsurf/resources/campaign/program_resources.py,sha256=e6ANK-_kuU5YTMQwKCCt35iO
 growsurf/resources/campaign/reward.py,sha256=-TiRwBcG5UwdNO_ath3pL36Bimji2QXCxSFNW8Scanw,14308
 growsurf/resources/campaign/rewards.py,sha256=tvSkGncj-2OA3G-ivuKsjv1HF9PKsZmcZRWBOR89JGA,37329
 growsurf/resources/campaign/webhooks.py,sha256=DRJ8-8QDibGEq1hT7MTkrlE5kdbEapZXiZb2z_kKM68,22666
-growsurf/types/__init__.py,sha256=MN3gMKVWqnmx1MhEP_XYKbrZMKMXYKxkS0pi-iAFi7g,4100
+growsurf/types/__init__.py,sha256=8MnE5xKMTKwLgZ3kMTHzsJoKhUFsBp3DTJoJ-cY_UK4,4302
 growsurf/types/account_create_params.py,sha256=BXaWsGsiiSbYvVy6ftPNwu7nA2m1xI4PvE1xGEoGeCo,602
 growsurf/types/affiliate_application.py,sha256=ilpjKfA53jQf-gRiO9u6TkHDI-gBWijQiEKAe6rr0Oc,2488
 growsurf/types/affiliate_application_answer.py,sha256=9AgNAiFl_UiPTn3241LQXXdLXt16nXMeUg0enDJbWVU,914
@@ -78,6 +78,8 @@ growsurf/types/email_analytics.py,sha256=7nypZsSLmyd-_inLzBfB8Vpbu4z0j-2TAU6Np9P
 growsurf/types/participant_commission_list.py,sha256=2xPLCwjcswv0K_1upzSrRNvY3kiuMX422gXpBuL3eqc,2033
 growsurf/types/participant_list.py,sha256=hdV0rzEwdx7trXyKmQ3aDq7Fy1KI8grL-t7SphGFP7M,429
 growsurf/types/participant_payout_list.py,sha256=WjJdzNcJCRwati9E7e7KBZNbLnv-WhxhhOL825b3oKo,1582
+growsurf/types/referral_flow_screenshot.py,sha256=mjQU2zEoOMMuNhYe6Pm9hpihVLCauMhT6_X9BNwTN-g,902
+growsurf/types/referral_flow_screenshots_response.py,sha256=1hxbw6YAuWyHhg1THHICpDkk8_JadyyZfU_H3MY_QWE,739
 growsurf/types/referral_list.py,sha256=SOU3s0cjeQLhbZVbeGoeCprVyrPTk-tvmMBMV25uG1o,969
 growsurf/types/rotate_api_key_response.py,sha256=dzF80t7wkpHAso5u9QciHNzYww3qTsEmE9LJ4XAQPGM,376
 growsurf/types/team.py,sha256=m7_7iAbceXcnryJClCOkcUbvG1MeMoIDb9fEy_8JXcA,741
@@ -99,7 +101,7 @@ growsurf/types/campaign/email_participant_response.py,sha256=A6i_s-YZnS8zYcKbMlZ
 growsurf/types/campaign/fraud_risk_level.py,sha256=e14xAEYtKH6gGnkJ9-sr81GZ2UY-zDQ6TZKCkBJLagw,228
 growsurf/types/campaign/integration.py,sha256=MIBG_M_zQJ_KHd-w_nCgCvP62o8eY0Q-IKwP-rzJ_oM,1223
 growsurf/types/campaign/integration_list_response.py,sha256=w09nrHrwarPJsDmNDxcDgMFsesAAF5H6leueoET6wNU,417
-growsurf/types/campaign/participant.py,sha256=9WGZVqE5o32FotmK0r6Oiz1vwxLUpVRQlGBkoS-ZjNE,7377
+growsurf/types/campaign/participant.py,sha256=rGSPmIDGeXuyirBWn3sqJVjwBii7pD9dfkI9-eYKVmM,7793
 growsurf/types/campaign/participant_activation_analytics.py,sha256=AB5Bdy60t-nc3_INVw03TKpp63lllutw8mSNPLZro7w,2686
 growsurf/types/campaign/participant_activity_logs_response.py,sha256=W-inUKJZimgwGlL6FqGlyQxG-XC9H7fnYMHtVi__uAQ,783
 growsurf/types/campaign/participant_add_params.py,sha256=ZbumRAnFwQchXRozOpOqkS7FFvqsuco8R7Az9S6kjSc,1821
@@ -150,7 +152,7 @@ growsurf/types/campaign/webhook_list_response.py,sha256=tSk9nTbcsj5Y-j4RjQwu9SZc
 growsurf/types/campaign/webhook_test_params.py,sha256=X1Osg9-4KGJbZauG_7rDqTE7cKCypeSzgumIhnxj9dk,468
 growsurf/types/campaign/webhook_test_response.py,sha256=AahcckKSLUeIgpwlosOOmbkioF62xREXgLbieHAPAdI,576
 growsurf/types/campaign/webhook_update_params.py,sha256=SavKhws8pfybC7O40ovtCreEmOwihEGPOCEX9Iua9cE,598
-growsurf_python-1.8.0.dist-info/METADATA,sha256=6VfPb2t_SXzOL3LDbCK2N6DoTTjJkRmDlfzRu00LcM0,13949
-growsurf_python-1.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-growsurf_python-1.8.0.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
-growsurf_python-1.8.0.dist-info/RECORD,,
+growsurf_python-1.9.0.dist-info/METADATA,sha256=yheSjK7zOq3Tmoj0YXsrt5_qT8Zou9nQwqYxK-w5pNU,13949
+growsurf_python-1.9.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+growsurf_python-1.9.0.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
+growsurf_python-1.9.0.dist-info/RECORD,,