growsurf-python 1.2.0__tar.gz → 1.3.0__tar.gz

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

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

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.3.0](https://github.com/growsurf/growsurf-python/compare/v1.2.1...v1.3.0) (2026-08-23)
+
+
+### Features
+
+* **api:** add affiliate and payout destination APIs ([29fe1c8](https://github.com/growsurf/growsurf-python/commit/29fe1c87053a539fa726898c3fd1b5ff368adf9e))
+* **api:** add affiliate and payout destination APIs ([a27f73b](https://github.com/growsurf/growsurf-python/commit/a27f73b3be157f58b5f067abc08b73ef855ce2c0))
+* release 1.3.0 with Python 3.10 baseline and analytics updates ([e01d6a0](https://github.com/growsurf/growsurf-python/commit/e01d6a0ae5824065c197f54210f94cea8760d524))
+
+
+### Bug Fixes
+
+* **api:** align analytics reward status models ([ffe8879](https://github.com/growsurf/growsurf-python/commit/ffe8879481fbf8ea8f660135b65ace1cb9f463da))
+
+## [1.2.1](https://github.com/growsurf/growsurf-python/compare/v1.2.0...v1.2.1) (2026-07-14)
+
+
+### Bug Fixes
+
+* align method docs with the REST v2 contract ([57e44e9](https://github.com/growsurf/growsurf-python/commit/57e44e906100c23d85d5dfbfabcd3821ef14d629))
+
 ## [1.2.0](https://github.com/growsurf/growsurf-python/compare/v1.1.2...v1.2.0) (2026-07-13)
 
 

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.2.0
+Version: 1.3.0
 Summary: The official Python library for the growsurf API
 Project-URL: Homepage, https://github.com/growsurf/growsurf-python
 Project-URL: Repository, https://github.com/growsurf/growsurf-python
@@ -13,7 +13,6 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: OS Independent
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -21,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: anyio<5,>=3.5.0
 Requires-Dist: distro<2,>=1.7.0
 Requires-Dist: httpx<1,>=0.23.0
@@ -29,7 +28,7 @@ Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.14
 Provides-Extra: aiohttp
-Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: aiohttp<4,>=3.14.3; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
@@ -38,7 +37,7 @@ Description-Content-Type: text/markdown
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/growsurf-python.svg?label=pypi%20(stable)&cacheSeconds=300)](https://pypi.org/project/growsurf-python/)
 
-The Growsurf Python library provides convenient access to the Growsurf REST API from any Python 3.9+
+The Growsurf Python library provides convenient access to the Growsurf REST API from any Python 3.10+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -392,7 +391,7 @@ print(growsurf.__version__)
 
 ## Requirements
 
-Python 3.9 or higher.
+Python 3.10 or higher.
 
 ## Contributing
 

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/README.md

@@ -3,7 +3,7 @@
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/growsurf-python.svg?label=pypi%20(stable)&cacheSeconds=300)](https://pypi.org/project/growsurf-python/)
 
-The Growsurf Python library provides convenient access to the Growsurf REST API from any Python 3.9+
+The Growsurf Python library provides convenient access to the Growsurf REST API from any Python 3.10+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -357,7 +357,7 @@ print(growsurf.__version__)
 
 ## Requirements
 
-Python 3.9 or higher.
+Python 3.10 or higher.
 
 ## Contributing
 

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/api.md

@@ -39,6 +39,11 @@ Types:
 ```python
 from growsurf.types import (
     Campaign,
+    AffiliateInvite,
+    AffiliateApplication,
+    AffiliateApplicationAnswer,
+    AffiliateInviteListResponse,
+    AffiliateApplicationListResponse,
     CommissionStructure,
     ParticipantCommissionList,
     ParticipantList,
@@ -64,6 +69,13 @@ Methods:
 - <code title="get /campaign/{id}/payouts">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_payouts</a>(id, \*\*<a href="src/growsurf/types/campaign_list_payouts_params.py">params</a>) -> <a href="./src/growsurf/types/participant_payout_list.py">ParticipantPayoutList</a></code>
 - <code title="get /campaign/{id}/referrals">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_referrals</a>(id, \*\*<a href="src/growsurf/types/campaign_list_referrals_params.py">params</a>) -> <a href="./src/growsurf/types/referral_list.py">ReferralList</a></code>
 - <code title="get /campaign/{id}/analytics">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">retrieve_analytics</a>(id, \*\*<a href="src/growsurf/types/campaign_retrieve_analytics_params.py">params</a>) -> <a href="./src/growsurf/types/campaign_retrieve_analytics_response.py">CampaignRetrieveAnalyticsResponse</a></code>
+- <code title="get /campaign/{id}/affiliate-applications">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_affiliate_applications</a>(id, \*\*<a href="src/growsurf/types/campaign_list_affiliate_applications_params.py">params</a>) -> <a href="./src/growsurf/types/affiliate_application_list_response.py">AffiliateApplicationListResponse</a></code>
+- <code title="get /campaign/{id}/affiliate-applications/{applicationId}">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">retrieve_affiliate_application</a>(application_id, \*, id) -> <a href="./src/growsurf/types/affiliate_application.py">AffiliateApplication</a></code>
+- <code title="patch /campaign/{id}/affiliate-applications/{applicationId}">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">review_affiliate_application</a>(application_id, \*, id, \*\*<a href="src/growsurf/types/campaign_review_affiliate_application_params.py">params</a>) -> <a href="./src/growsurf/types/affiliate_application.py">AffiliateApplication</a></code>
+- <code title="get /campaign/{id}/affiliate-invites">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">list_affiliate_invites</a>(id, \*\*<a href="src/growsurf/types/campaign_list_affiliate_invites_params.py">params</a>) -> <a href="./src/growsurf/types/affiliate_invite_list_response.py">AffiliateInviteListResponse</a></code>
+- <code title="post /campaign/{id}/affiliate-invites">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">create_affiliate_invite</a>(id, \*\*<a href="src/growsurf/types/campaign_create_affiliate_invite_params.py">params</a>) -> <a href="./src/growsurf/types/affiliate_invite.py">AffiliateInvite</a></code>
+- <code title="delete /campaign/{id}/affiliate-invites/{inviteId}">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">revoke_affiliate_invite</a>(invite_id, \*, id) -> <a href="./src/growsurf/types/affiliate_invite.py">AffiliateInvite</a></code>
+- <code title="post /campaign/{id}/affiliate-invites/{inviteId}/resend">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">resend_affiliate_invite</a>(invite_id, \*, id) -> <a href="./src/growsurf/types/affiliate_invite.py">AffiliateInvite</a></code>
 
 ## Participant
 
@@ -71,7 +83,6 @@ Types:
 
 ```python
 from growsurf.types.campaign import (
-    Create,
     FraudRiskLevel,
     Participant,
     ParticipantReward,
@@ -87,6 +98,8 @@ from growsurf.types.campaign import (
     ParticipantRefundTransactionResponse,
     ParticipantSendInvitesResponse,
     ParticipantTriggerReferralResponse,
+    ParticipantGetPayoutDestinationResponse,
+    ParticipantRequestPayoutDestinationConfirmationResponse,
 )
 ```
 
@@ -109,6 +122,8 @@ Methods:
 - <code title="post /campaign/{id}/participant/{participantIdOrEmail}/email">client.campaign.participant.<a href="./src/growsurf/resources/campaign/participant.py">email</a>(participant_id_or_email, \*, id, \*\*<a href="src/growsurf/types/campaign/participant_email_params.py">params</a>) -> <a href="./src/growsurf/types/campaign/email_participant_response.py">EmailParticipantResponse</a></code>
 - <code title="get /campaign/{id}/participant/{participantIdOrEmail}/activity-logs">client.campaign.participant.<a href="./src/growsurf/resources/campaign/participant.py">list_activity_logs</a>(participant_id_or_email, \*, id, \*\*<a href="src/growsurf/types/campaign/participant_list_activity_logs_params.py">params</a>) -> <a href="./src/growsurf/types/campaign/participant_activity_logs_response.py">ParticipantActivityLogsResponse</a></code>
 - <code title="get /campaign/{id}/participant/{participantIdOrEmail}/analytics">client.campaign.participant.<a href="./src/growsurf/resources/campaign/participant.py">retrieve_analytics</a>(participant_id_or_email, \*, id, \*\*<a href="src/growsurf/types/campaign/participant_analytics_params.py">params</a>) -> <a href="./src/growsurf/types/campaign/participant_analytics_response.py">ParticipantAnalyticsResponse</a></code>
+- <code title="get /campaign/{id}/participant/{participantIdOrEmail}/payout-destination">client.campaign.participant.<a href="./src/growsurf/resources/campaign/participant.py">get_payout_destination</a>(participant_id_or_email, \*, id) -> <a href="./src/growsurf/types/campaign/participant_get_payout_destination_response.py">ParticipantGetPayoutDestinationResponse</a></code>
+- <code title="post /campaign/{id}/participant/{participantIdOrEmail}/payout-destination/request-confirmation">client.campaign.participant.<a href="./src/growsurf/resources/campaign/participant.py">request_payout_destination_confirmation</a>(participant_id_or_email, \*, id, \*\*<a href="src/growsurf/types/campaign/participant_request_payout_destination_confirmation_params.py">params</a>) -> <a href="./src/growsurf/types/campaign/participant_request_payout_destination_confirmation_response.py">ParticipantRequestPayoutDestinationConfirmationResponse</a></code>
 
 ## Reward
 

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "growsurf-python"
-version = "1.2.0"
+version = "1.3.0"
 description = "The official Python library for the growsurf API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -17,11 +17,10 @@ dependencies = [
   "sniffio",
 ]
 
-requires-python = ">= 3.9"
+requires-python = ">= 3.10"
 classifiers = [
   "Typing :: Typed",
   "Intended Audience :: Developers",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
@@ -41,7 +40,7 @@ Homepage = "https://github.com/growsurf/growsurf-python"
 Repository = "https://github.com/growsurf/growsurf-python"
 
 [project.optional-dependencies]
-aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"]
+aiohttp = ["aiohttp>=3.14.3,<4", "httpx_aiohttp>=0.1.9"]
 
 [tool.uv]
 managed = true
@@ -129,7 +128,7 @@ filterwarnings = [
 # there are a couple of flags that are still disabled by
 # default in strict mode as they are experimental and niche.
 typeCheckingMode = "strict"
-pythonVersion = "3.9"
+pythonVersion = "3.10"
 
 exclude = [
     "_dev",

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/src/growsurf/_base_client.py

@@ -789,6 +789,15 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
         timeout = sleep_seconds * jitter
         return timeout if timeout >= 0 else 0
 
+    def _request_is_retry_safe(self, options: FinalRequestOptions) -> bool:
+        """Return whether replaying the request cannot duplicate a customer-visible mutation."""
+        method = options.method.lower()
+        url = URL(str(options.url))
+        path = url.path.rstrip("/")
+        return method in {"get", "head"} or (
+            method == "post" and url.is_relative_url and path == "/api-key/rotate"
+        )
+
     def _should_retry(self, response: httpx.Response) -> bool:
         # Note: this is not a standard header
         should_retry_header = response.headers.get("x-should-retry")
@@ -994,9 +1003,10 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
         # options are mutated later & we then retry, the retries are
         # given the original options
         input_options = model_copy(options)
-        if input_options.idempotency_key is None and input_options.method.lower() != "get":
+        if input_options.idempotency_key is None and self._request_is_retry_safe(input_options):
             # ensure the idempotency key is reused between requests
-            input_options.idempotency_key = self._idempotency_key()
+            if input_options.method.lower() == "post":
+                input_options.idempotency_key = self._idempotency_key()
 
         response: httpx.Response | None = None
         max_retries = input_options.get_max_retries(self.max_retries)
@@ -1030,7 +1040,7 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
             except httpx.TimeoutException as err:
                 log.debug("Encountered httpx.TimeoutException", exc_info=True)
 
-                if remaining_retries > 0:
+                if remaining_retries > 0 and self._request_is_retry_safe(input_options):
                     self._sleep_for_retry(
                         retries_taken=retries_taken,
                         max_retries=max_retries,
@@ -1044,7 +1054,7 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
             except Exception as err:
                 log.debug("Encountered Exception", exc_info=True)
 
-                if remaining_retries > 0:
+                if remaining_retries > 0 and self._request_is_retry_safe(input_options):
                     self._sleep_for_retry(
                         retries_taken=retries_taken,
                         max_retries=max_retries,
@@ -1070,7 +1080,11 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
             except httpx.HTTPStatusError as err:  # thrown on 4xx and 5xx status code
                 log.debug("Encountered httpx.HTTPStatusError", exc_info=True)
 
-                if remaining_retries > 0 and self._should_retry(err.response):
+                if (
+                    remaining_retries > 0
+                    and self._request_is_retry_safe(input_options)
+                    and self._should_retry(err.response)
+                ):
                     err.response.close()
                     self._sleep_for_retry(
                         retries_taken=retries_taken,
@@ -1579,9 +1593,10 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
         # options are mutated later & we then retry, the retries are
         # given the original options
         input_options = model_copy(options)
-        if input_options.idempotency_key is None and input_options.method.lower() != "get":
+        if input_options.idempotency_key is None and self._request_is_retry_safe(input_options):
             # ensure the idempotency key is reused between requests
-            input_options.idempotency_key = self._idempotency_key()
+            if input_options.method.lower() == "post":
+                input_options.idempotency_key = self._idempotency_key()
 
         response: httpx.Response | None = None
         max_retries = input_options.get_max_retries(self.max_retries)
@@ -1614,7 +1629,7 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
             except httpx.TimeoutException as err:
                 log.debug("Encountered httpx.TimeoutException", exc_info=True)
 
-                if remaining_retries > 0:
+                if remaining_retries > 0 and self._request_is_retry_safe(input_options):
                     await self._sleep_for_retry(
                         retries_taken=retries_taken,
                         max_retries=max_retries,
@@ -1628,7 +1643,7 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
             except Exception as err:
                 log.debug("Encountered Exception", exc_info=True)
 
-                if remaining_retries > 0:
+                if remaining_retries > 0 and self._request_is_retry_safe(input_options):
                     await self._sleep_for_retry(
                         retries_taken=retries_taken,
                         max_retries=max_retries,
@@ -1654,7 +1669,11 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
             except httpx.HTTPStatusError as err:  # thrown on 4xx and 5xx status code
                 log.debug("Encountered httpx.HTTPStatusError", exc_info=True)
 
-                if remaining_retries > 0 and self._should_retry(err.response):
+                if (
+                    remaining_retries > 0
+                    and self._request_is_retry_safe(input_options)
+                    and self._should_retry(err.response)
+                ):
                     await err.response.aclose()
                     await self._sleep_for_retry(
                         retries_taken=retries_taken,

{growsurf_python-1.2.0 → growsurf_python-1.3.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.2.0"  # x-release-please-version
+__version__ = "1.3.0"  # x-release-please-version

{growsurf_python-1.2.0 → growsurf_python-1.3.0}/src/growsurf/resources/account.py

@@ -46,11 +46,21 @@ class AccountResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CreateAccountResponse:
-        """Create a GrowSurf account and return its one-time API key.
-
-        The key is locked until the team owner's email address is verified and rotates the
-        first time the account owner signs in to the GrowSurf dashboard. Accounts whose
-        email is never verified are deleted automatically after 7 days.
+        """
+        Creates a new GrowSurf account. This is the only endpoint that does not require
+        an API key. The response includes an API key for the new account, shown once in
+        the response. The key is locked until the team owner's email address is
+        verified: authenticated program and resource endpoints return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+        /team/owner/verification-email`, then retry). A welcome email is sent to the
+        address with the verification link and a set-password link for dashboard access.
+        Accounts whose email is never verified are deleted automatically after 7 days.
+        For security, the API key is rotated the first time the account owner signs in
+        to the GrowSurf dashboard. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. By creating an account
+        you agree, on behalf of the account holder, to GrowSurf's [Terms of
+        Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy).
 
         Args:
           email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.
@@ -116,11 +126,21 @@ class AsyncAccountResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CreateAccountResponse:
-        """Create a GrowSurf account and return its one-time API key.
-
-        The key is locked until the team owner's email address is verified and rotates the
-        first time the account owner signs in to the GrowSurf dashboard. Accounts whose
-        email is never verified are deleted automatically after 7 days.
+        """
+        Creates a new GrowSurf account. This is the only endpoint that does not require
+        an API key. The response includes an API key for the new account, shown once in
+        the response. The key is locked until the team owner's email address is
+        verified: authenticated program and resource endpoints return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+        /team/owner/verification-email`, then retry). A welcome email is sent to the
+        address with the verification link and a set-password link for dashboard access.
+        Accounts whose email is never verified are deleted automatically after 7 days.
+        For security, the API key is rotated the first time the account owner signs in
+        to the GrowSurf dashboard. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. By creating an account
+        you agree, on behalf of the account holder, to GrowSurf's [Terms of
+        Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy).
 
         Args:
           email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.