growsurf-python 1.4.0__tar.gz → 1.5.0__tar.gz

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

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

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [1.5.0](https://github.com/growsurf/growsurf-python/compare/v1.4.0...v1.5.0) (2026-09-10)
+
+
+### Features
+
+* **api:** add campaign integrations list endpoint ([8c03034](https://github.com/growsurf/growsurf-python/commit/8c030344295d243028f6949d033e658dce29d1c9))
+* **api:** add EMBEDDABLE_ELEMENT portal view source ([beb0a4b](https://github.com/growsurf/growsurf-python/commit/beb0a4b371924bb08800796190d963b34baf52d7))
+* **api:** add paymentProvider and testMode to transaction params ([42c3297](https://github.com/growsurf/growsurf-python/commit/42c32971fa5ba3de8e8eb510cf9e1de1799574fc))
+* **api:** add refundHistoryComplete to refund transaction params ([08e67d7](https://github.com/growsurf/growsurf-python/commit/08e67d797bcdf41949f752ef44bc7f3194f5e82f))
+* **api:** sync analytics and program resources ([3fc6106](https://github.com/growsurf/growsurf-python/commit/3fc610630ccc6e1a138ab998f8a0bafcf5e2f7d2))
+* **api:** sync reward, program resource, and analytics types with the REST contract ([45d95ea](https://github.com/growsurf/growsurf-python/commit/45d95ea7504e5e5f74a2a16cd521a8d03800d0e1))
+
+
+### Chores
+
+* apply ruff formatting ([fb8d066](https://github.com/growsurf/growsurf-python/commit/fb8d066a4df35e73eb7b9ea79c31f21bd2bab02b))
+
 ## [1.4.0](https://github.com/growsurf/growsurf-python/compare/v1.3.0...v1.4.0) (2026-08-25)
 
 

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/CONTRIBUTING.md

@@ -34,13 +34,12 @@ $ pip install -r requirements-dev.lock
 
 ## Modifying/Adding code
 
-Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
-result in merge conflicts between manual patches and changes from the generator. The generator will never
-modify the contents of the `src/growsurf/lib/` and `examples/` directories.
+GrowSurf maintains this SDK by hand. Keep resources, request and response types, exports, documentation,
+and tests aligned with the public GrowSurf OpenAPI contract.
 
 ## Adding and running examples
 
-All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
+Examples are maintained by hand and can be freely edited or added to.
 
 ```py
 # add an example to examples/<your-example>.py

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.4.0
+Version: 1.5.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
@@ -41,7 +41,7 @@ The Growsurf Python library provides convenient access to the Growsurf REST API
 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).
 
-It is generated with [Stainless](https://www.stainless.com/).
+The library was originally generated with [Stainless](https://www.stainless.com/) and is now maintained by hand.
 
 ## Documentation
 
@@ -174,18 +174,23 @@ Error codes are as follows:
 | ----------- | -------------------------- |
 | 400         | `BadRequestError`          |
 | 401         | `AuthenticationError`      |
+| 402         | `APIStatusError`           |
 | 403         | `PermissionDeniedError`    |
 | 404         | `NotFoundError`            |
+| 406         | `APIStatusError`           |
+| 409         | `ConflictError`            |
 | 422         | `UnprocessableEntityError` |
+| 423         | `APIStatusError`           |
 | 429         | `RateLimitError`           |
 | >=500       | `InternalServerError`      |
 | N/A         | `APIConnectionError`       |
 
 ### Retries
 
-Certain errors are automatically retried 2 times by default, with a short exponential backoff.
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
-429 Rate Limit, and >=500 Internal errors are all retried by default.
+`GET` and `HEAD` requests are retried up to 2 times by default, with a short exponential backoff. API-key rotation is also retried because the SDK generates and reuses an `Idempotency-Key` for that request. Other `POST`, `PATCH`, and `DELETE` requests are not retried automatically.
+
+For requests that are safe to retry, the SDK retries connection errors, 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors.
 
 You can use the `max_retries` option to configure or disable retry settings:
 

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/README.md

@@ -7,7 +7,7 @@ The Growsurf Python library provides convenient access to the Growsurf REST API
 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).
 
-It is generated with [Stainless](https://www.stainless.com/).
+The library was originally generated with [Stainless](https://www.stainless.com/) and is now maintained by hand.
 
 ## Documentation
 
@@ -140,18 +140,23 @@ Error codes are as follows:
 | ----------- | -------------------------- |
 | 400         | `BadRequestError`          |
 | 401         | `AuthenticationError`      |
+| 402         | `APIStatusError`           |
 | 403         | `PermissionDeniedError`    |
 | 404         | `NotFoundError`            |
+| 406         | `APIStatusError`           |
+| 409         | `ConflictError`            |
 | 422         | `UnprocessableEntityError` |
+| 423         | `APIStatusError`           |
 | 429         | `RateLimitError`           |
 | >=500       | `InternalServerError`      |
 | N/A         | `APIConnectionError`       |
 
 ### Retries
 
-Certain errors are automatically retried 2 times by default, with a short exponential backoff.
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
-429 Rate Limit, and >=500 Internal errors are all retried by default.
+`GET` and `HEAD` requests are retried up to 2 times by default, with a short exponential backoff. API-key rotation is also retried because the SDK generates and reuses an `Idempotency-Key` for that request. Other `POST`, `PATCH`, and `DELETE` requests are not retried automatically.
+
+For requests that are safe to retry, the SDK retries connection errors, 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors.
 
 You can use the `max_retries` option to configure or disable retry settings:
 

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/api.md

@@ -176,6 +176,18 @@ Methods:
 - <code title="get /campaign/{id}/reward-configs">client.campaign.rewards.<a href="./src/growsurf/resources/campaign/rewards.py">list</a>(id) -> <a href="./src/growsurf/types/campaign/campaign_reward_list_response.py">CampaignRewardListResponse</a></code>
 - <code title="delete /campaign/{id}/reward-configs/{campaignRewardId}">client.campaign.rewards.<a href="./src/growsurf/resources/campaign/rewards.py">delete</a>(campaign_reward_id, \*, id) -> <a href="./src/growsurf/types/campaign/delete_reward_response.py">DeleteRewardResponse</a></code>
 
+## Integrations
+
+Types:
+
+```python
+from growsurf.types.campaign import Integration, IntegrationListResponse
+```
+
+Methods:
+
+- <code title="get /campaign/{id}/integrations">client.campaign.integrations.<a href="./src/growsurf/resources/campaign/integrations.py">list</a>(id) -> <a href="./src/growsurf/types/campaign/integration_list_response.py">IntegrationListResponse</a></code>
+
 ## Webhooks
 
 Types:
@@ -203,7 +215,11 @@ Methods:
 Types:
 
 ```python
-from growsurf.types.campaign import CampaignDesign
+from growsurf.types.campaign import (
+    CampaignDesign,
+    CampaignDesignResources,
+    CampaignDesignResourcesIcon,
+)
 ```
 
 Methods:

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/pyproject.toml

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

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/src/growsurf/_base_client.py

@@ -794,9 +794,7 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
         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"
-        )
+        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

{growsurf_python-1.4.0 → growsurf_python-1.5.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.4.0"  # x-release-please-version
+__version__ = "1.5.0"  # x-release-please-version

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/src/growsurf/resources/account.py

@@ -48,19 +48,25 @@ class AccountResource(SyncAPIResource):
     ) -> CreateAccountResponse:
         """
         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
+        an API key. Before calling it, an authorized account owner must review and
+        approve GrowSurf's [Terms of Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy). The account starts a 14-day Business
+        trial without a credit card. The response includes an API key for the new
+        account, shown once in the response. The key is a secret: store it in a secret
+        manager and do not put it in logs, screenshots, URLs, model context, analytics,
+        or generated output. 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).
+        /team/owner/verification-email`, then retry). Verification unlocks this same key
+        - keep it and retry rather than requesting a replacement. 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. Separately, for security, the API key is replaced
+        the first time the account owner signs in to the GrowSurf dashboard; email
+        verification does not trigger that, and the previous key then returns a `403`
+        with error code `NOT_AUTHORIZED_ERROR`. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. Calling this endpoint
+        accepts those policies on the account holder's behalf.
 
         Args:
           email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.
@@ -128,19 +134,25 @@ class AsyncAccountResource(AsyncAPIResource):
     ) -> CreateAccountResponse:
         """
         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
+        an API key. Before calling it, an authorized account owner must review and
+        approve GrowSurf's [Terms of Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy). The account starts a 14-day Business
+        trial without a credit card. The response includes an API key for the new
+        account, shown once in the response. The key is a secret: store it in a secret
+        manager and do not put it in logs, screenshots, URLs, model context, analytics,
+        or generated output. 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).
+        /team/owner/verification-email`, then retry). Verification unlocks this same key
+        - keep it and retry rather than requesting a replacement. 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. Separately, for security, the API key is replaced
+        the first time the account owner signs in to the GrowSurf dashboard; email
+        verification does not trigger that, and the previous key then returns a `403`
+        with error code `NOT_AUTHORIZED_ERROR`. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. Calling this endpoint
+        accepts those policies on the account holder's behalf.
 
         Args:
           email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.

{growsurf_python-1.4.0 → growsurf_python-1.5.0}/src/growsurf/resources/campaign/__init__.py

@@ -80,6 +80,22 @@ from .installation import (
     InstallationResourceWithStreamingResponse,
     AsyncInstallationResourceWithStreamingResponse,
 )
+from .integrations import (
+    IntegrationsResource,
+    AsyncIntegrationsResource,
+    IntegrationsResourceWithRawResponse,
+    AsyncIntegrationsResourceWithRawResponse,
+    IntegrationsResourceWithStreamingResponse,
+    AsyncIntegrationsResourceWithStreamingResponse,
+)
+from .program_resources import (
+    ProgramResourcesResource,
+    AsyncProgramResourcesResource,
+    ProgramResourcesResourceWithRawResponse,
+    AsyncProgramResourcesResourceWithRawResponse,
+    ProgramResourcesResourceWithStreamingResponse,
+    AsyncProgramResourcesResourceWithStreamingResponse,
+)
 
 __all__ = [
     "ParticipantResource",
@@ -100,6 +116,18 @@ __all__ = [
     "AsyncRewardsResourceWithRawResponse",
     "RewardsResourceWithStreamingResponse",
     "AsyncRewardsResourceWithStreamingResponse",
+    "ProgramResourcesResource",
+    "AsyncProgramResourcesResource",
+    "ProgramResourcesResourceWithRawResponse",
+    "AsyncProgramResourcesResourceWithRawResponse",
+    "ProgramResourcesResourceWithStreamingResponse",
+    "AsyncProgramResourcesResourceWithStreamingResponse",
+    "IntegrationsResource",
+    "AsyncIntegrationsResource",
+    "IntegrationsResourceWithRawResponse",
+    "AsyncIntegrationsResourceWithRawResponse",
+    "IntegrationsResourceWithStreamingResponse",
+    "AsyncIntegrationsResourceWithStreamingResponse",
     "WebhooksResource",
     "AsyncWebhooksResource",
     "WebhooksResourceWithRawResponse",