growsurf-python 1.13.0__tar.gz → 1.13.1__tar.gz

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

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

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [1.13.1](https://github.com/growsurf/growsurf-python/compare/v1.13.0...v1.13.1) (2026-10-14)
+
+
+### Documentation
+
+* align SDK option guidance with the REST API ([f93027e](https://github.com/growsurf/growsurf-python/commit/f93027e3580e7412a7991c817912c19901d32721))
+* document language picker flag option ([304a4b4](https://github.com/growsurf/growsurf-python/commit/304a4b4dc9b452c07c04b694b6374df7e535d0e4))
+* sync SDK comments with the REST API contract ([bf3e679](https://github.com/growsurf/growsurf-python/commit/bf3e679d1dcb9db0380babec0f8030a8c0156454))
+
 ## [1.13.0](https://github.com/growsurf/growsurf-python/compare/v1.12.0...v1.13.0) (2026-10-09)
 
 

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.13.0
+Version: 1.13.1
 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.13.0 → growsurf_python-1.13.1}/pyproject.toml

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

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/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.13.0"  # x-release-please-version
+__version__ = "1.13.1"  # x-release-please-version

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/campaign.py

@@ -346,6 +346,9 @@ class CampaignResource(SyncAPIResource):
         configuration (design, emails, options, installation) is edited via the
         dedicated config sub-resources, not here. The program cannot be deleted via this
         endpoint.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -411,6 +414,7 @@ class CampaignResource(SyncAPIResource):
         """
         Clones an existing program into a new `DRAFT` program. Integrations and
         credentials are not copied; active rewards are cloned.
+        A concurrent edit to the program can return `409`; retry the clone.
 
         Args:
           extra_headers: Send extra headers
@@ -1577,6 +1581,9 @@ class AsyncCampaignResource(AsyncAPIResource):
         configuration (design, emails, options, installation) is edited via the
         dedicated config sub-resources, not here. The program cannot be deleted via this
         endpoint.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -1642,6 +1649,7 @@ class AsyncCampaignResource(AsyncAPIResource):
         """
         Clones an existing program into a new `DRAFT` program. Integrations and
         credentials are not copied; active rewards are cloned.
+        A concurrent edit to the program can return `409`; retry the clone.
 
         Args:
           extra_headers: Send extra headers

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/design.py

@@ -101,6 +101,9 @@ class DesignResource(SyncAPIResource):
         anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
         Unknown fields, fields not available for the program type, and invalid values return a
         `400`. Landing-page custom code and JavaScript are not editable via the API.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignDesign` object — only the fields you send are changed.
@@ -206,6 +209,9 @@ class AsyncDesignResource(AsyncAPIResource):
         anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
         Unknown fields, fields not available for the program type, and invalid values return a
         `400`. Landing-page custom code and JavaScript are not editable via the API.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignDesign` object — only the fields you send are changed.

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/emails.py

@@ -104,6 +104,9 @@ class EmailsResource(SyncAPIResource):
         available for the program type returns a `400`. Some fields are read-only
         (`settings.sender.fromEmail`, whose custom value requires dashboard domain
         verification).
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignEmails` object — only the fields you send are changed.
@@ -210,6 +213,9 @@ class AsyncEmailsResource(AsyncAPIResource):
         available for the program type returns a `400`. Some fields are read-only
         (`settings.sender.fromEmail`, whose custom value requires dashboard domain
         verification).
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignEmails` object — only the fields you send are changed.

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/installation.py

@@ -99,6 +99,9 @@ class InstallationResource(SyncAPIResource):
         enabling `mobile.isEnabled` creates one. Changing `shareUrl` re-resolves its
         redirect destinations, which may take a moment to complete. URLs must include an
         explicit `http://` or `https://` scheme.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignInstallation` object — only the fields you send are changed.
@@ -200,6 +203,9 @@ class AsyncInstallationResource(AsyncAPIResource):
         enabling `mobile.isEnabled` creates one. Changing `shareUrl` re-resolves its
         redirect destinations, which may take a moment to complete. URLs must include an
         explicit `http://` or `https://` scheme.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignInstallation` object — only the fields you send are changed.

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/options.py

@@ -56,12 +56,11 @@ class OptionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Retrieves a program's options — the same surface as the dashboard Program
-        Editor's **Options** tab. Includes reward/fraud approval, anti-fraud lists +
-        toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment +
-        application review, payout threshold + tax settings (affiliate only), and
-        notification-email settings, and `attributionModel` (`LAST_CLICK` or
-        `FIRST_CLICK`). `fraud.recaptcha.secretKey` is never returned.
+        Retrieves a program's options — the same surface as the dashboard Program Editor's
+        **Options** tab. Includes the attribution model, reward/fraud approval, anti-fraud lists
+        + toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment + application
+        review, payout threshold + tax settings (affiliate only), notification-email settings,
+        and the program's languages. `fraud.recaptcha.secretKey` is never returned.
 
         Args:
           extra_headers: Send extra headers
@@ -101,6 +100,12 @@ class OptionsResource(SyncAPIResource):
         and `payoutThreshold`/`taxDocumentation` are affiliate-only, and affiliate
         programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
         is write-only. `referralCreditWindowDays: null` means "never expires".
+        Turning on `languages.additionalLanguages` requires the Business plan or higher. While
+        any are on, every `languages` change, including turning them off, requires it too (`403`
+        otherwise).
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignOptions` object — only the fields you send are changed.
@@ -159,12 +164,11 @@ class AsyncOptionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Retrieves a program's options — the same surface as the dashboard Program
-        Editor's **Options** tab. Includes reward/fraud approval, anti-fraud lists +
-        toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment +
-        application review, payout threshold + tax settings (affiliate only), and
-        notification-email settings, and `attributionModel` (`LAST_CLICK` or
-        `FIRST_CLICK`). `fraud.recaptcha.secretKey` is never returned.
+        Retrieves a program's options — the same surface as the dashboard Program Editor's
+        **Options** tab. Includes the attribution model, reward/fraud approval, anti-fraud lists
+        + toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment + application
+        review, payout threshold + tax settings (affiliate only), notification-email settings,
+        and the program's languages. `fraud.recaptcha.secretKey` is never returned.
 
         Args:
           extra_headers: Send extra headers
@@ -204,6 +208,12 @@ class AsyncOptionsResource(AsyncAPIResource):
         and `payoutThreshold`/`taxDocumentation` are affiliate-only, and affiliate
         programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
         is write-only. `referralCreditWindowDays: null` means "never expires".
+        Turning on `languages.additionalLanguages` requires the Business plan or higher. While
+        any are on, every `languages` change, including turning them off, requires it too (`403`
+        otherwise).
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           body: A partial `CampaignOptions` object — only the fields you send are changed.

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/resources/campaign/rewards.py

@@ -89,6 +89,7 @@ class RewardsResource(SyncAPIResource):
         support only `AFFILIATE` rewards; referral programs support all other types).
         Enabling an active reward of a type automatically enables that reward type on
         the program.
+        A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           type: The reward type. Immutable after creation.
@@ -221,6 +222,9 @@ class RewardsResource(SyncAPIResource):
         keys automatically rewrite any `{{campaignReward[…]}}` references in campaign
         copy; removing a key that campaign copy still references returns a `409` listing
         the referencing fields.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           commission_structure: The affiliate commission structure (AFFILIATE rewards only).
@@ -455,6 +459,7 @@ class AsyncRewardsResource(AsyncAPIResource):
         support only `AFFILIATE` rewards; referral programs support all other types).
         Enabling an active reward of a type automatically enables that reward type on
         the program.
+        A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           type: The reward type. Immutable after creation.
@@ -587,6 +592,9 @@ class AsyncRewardsResource(AsyncAPIResource):
         keys automatically rewrite any `{{campaignReward[…]}}` references in campaign
         copy; removing a key that campaign copy still references returns a `409` listing
         the referencing fields.
+        Changes to participant email content are checked before saving. Rejected content returns
+        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
+        change. A concurrent edit can return `409`; reload the program before retrying.
 
         Args:
           commission_structure: The affiliate commission structure (AFFILIATE rewards only).

{growsurf_python-1.13.0 → growsurf_python-1.13.1}/src/growsurf/types/campaign/campaign_options.py

@@ -9,8 +9,8 @@ __all__ = ["CampaignOptions"]
 # approval, anti-fraud lists + toggles, the `LAST_CLICK` or `FIRST_CLICK`
 # attribution model, referral windows, reCAPTCHA, affiliate enrollment +
 # application review, payout + tax settings (affiliate only), notification-email
-# settings, and the program's `languages` (`baseLanguage` and
-# `additionalLanguages`). It is intentionally modeled as a loose object. To see the full
+# settings, and the program's `languages` (`baseLanguage`, `additionalLanguages`,
+# and `showFlags`). It is intentionally modeled as a loose object. To see the full
 # object with every field and its current value, `GET` the resource, then `PATCH`
 # back only the fields you want to change.
 CampaignOptions: TypeAlias = Dict[str, object]

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

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