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

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

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

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

@@ -1,5 +1,28 @@
 # Changelog
 
+## [1.13.0](https://github.com/growsurf/growsurf-python/compare/v1.12.0...v1.13.0) (2026-10-09)
+
+
+### Features
+
+* add program and participant language support ([57890e4](https://github.com/growsurf/growsurf-python/commit/57890e4ddfd3b2af6ac43d8caafdcf8ab013f3a6))
+* add program languages and update SDK guidance ([1925adb](https://github.com/growsurf/growsurf-python/commit/1925adb305c1ba3743dcbac397c06dfcb2444743))
+
+## [1.12.0](https://github.com/growsurf/growsurf-python/compare/v1.11.0...v1.12.0) (2026-10-07)
+
+
+### Chores
+
+* prepare SDK 1.12.0 ([4d51fd4](https://github.com/growsurf/growsurf-python/commit/4d51fd4048c70ea3a4ac68151f0c6ec455c5a5c8))
+* release 1.12.0 ([2a44995](https://github.com/growsurf/growsurf-python/commit/2a44995b52c7f6bdd360cc400a1b3aa64c0af7a8))
+
+
+### Documentation
+
+* clarify welcome email recipient eligibility ([3050cc3](https://github.com/growsurf/growsurf-python/commit/3050cc38e2f57cbe25d36352f1ddc124f333c4bf))
+* describe follow-up reminder eligibility and delay ([818359b](https://github.com/growsurf/growsurf-python/commit/818359b7806b6029ba06bf788471e17c00ae1363))
+* describe inline email layout and required footer token ([b13749a](https://github.com/growsurf/growsurf-python/commit/b13749a5abd8a8c12e85305ba54ead72055404ff))
+
 ## [1.11.0](https://github.com/growsurf/growsurf-python/compare/v1.10.0...v1.11.0) (2026-09-29)
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.11.0
+Version: 1.13.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.13.0/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Reporting Security Issues
+
+GrowSurf maintains this SDK. If you believe you have found a security vulnerability in it, please report it to support@growsurf.com rather than opening a public issue.
+
+## Responsible Disclosure
+
+Please give us a reasonable amount of time to investigate and address the issue before making any information public. We appreciate the efforts of security researchers who help keep this SDK and the systems it talks to secure.
+
+## Other GrowSurf Security Issues
+
+For security issues in GrowSurf products or services that are not related to this SDK, contact support@growsurf.com as well.

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/api.md

@@ -52,11 +52,23 @@ from growsurf.types import (
     CampaignListResponse,
     CampaignCreateMobileParticipantTokenResponse,
     CampaignRetrieveAnalyticsResponse,
+    CampaignActivationAnalyticsResponse,
     ReferralFlowScreenshot,
     ReferralFlowScreenshotsResponse,
 )
 ```
 
+```python
+from growsurf.types.campaign import (
+    ProgramResource,
+    ProgramResourceFile,
+    ProgramResourceListResponse,
+    ProgramResourceUploadResult,
+    ProgramResourceUploadTicket,
+    DeleteProgramResourceResponse,
+)
+```
+
 Methods:
 
 - <code title="post /campaigns">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">create</a>(\*\*<a href="src/growsurf/types/campaign_create_params.py">params</a>) -> <a href="./src/growsurf/types/campaign/campaign.py">Campaign</a></code>
@@ -72,6 +84,7 @@ 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}/analytics/activation">client.campaign.<a href="./src/growsurf/resources/campaign/campaign.py">retrieve_activation_analytics</a>(id, \*\*<a href="src/growsurf/types/campaign_retrieve_activation_analytics_params.py">params</a>) -> <a href="./src/growsurf/types/campaign_activation_analytics_response.py">CampaignActivationAnalyticsResponse</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>
@@ -79,6 +92,11 @@ Methods:
 - <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>
+- <code title="get /campaign/{id}/resources">client.campaign.resources.<a href="./src/growsurf/resources/campaign/program_resources.py">list</a>(id) -> <a href="./src/growsurf/types/campaign/program_resource_list_response.py">ProgramResourceListResponse</a></code>
+- <code title="post /campaign/{id}/resources">client.campaign.resources.<a href="./src/growsurf/resources/campaign/program_resources.py">create</a>(id, \*, type, title, description, category, is_published, url, text, upload_ticket, upload_result) -> <a href="./src/growsurf/types/campaign/program_resource.py">ProgramResource</a></code>
+- <code title="patch /campaign/{id}/resources/{resourceId}">client.campaign.resources.<a href="./src/growsurf/resources/campaign/program_resources.py">update</a>(resource_id, \*, id, type, title, description, category, is_published, position, url, text, upload_ticket, upload_result) -> <a href="./src/growsurf/types/campaign/program_resource.py">ProgramResource</a></code>
+- <code title="delete /campaign/{id}/resources/{resourceId}">client.campaign.resources.<a href="./src/growsurf/resources/campaign/program_resources.py">delete</a>(resource_id, \*, id) -> <a href="./src/growsurf/types/campaign/delete_program_resource_response.py">DeleteProgramResourceResponse</a></code>
+- <code title="post /campaign/{id}/resource-upload-tickets">client.campaign.resources.<a href="./src/growsurf/resources/campaign/program_resources.py">create_upload_ticket</a>(id, \*, file_name, mime_type, bytes) -> <a href="./src/growsurf/types/campaign/program_resource_upload_ticket.py">ProgramResourceUploadTicket</a></code>
 
 ## Participant
 
@@ -87,6 +105,7 @@ Types:
 ```python
 from growsurf.types.campaign import (
     FraudRiskLevel,
+    Language,
     Participant,
     ParticipantReward,
     ReferralSource,

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/pyproject.toml

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

{growsurf_python-1.11.0 → growsurf_python-1.13.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.11.0"  # x-release-please-version
+__version__ = "1.13.0"  # x-release-please-version

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

@@ -127,6 +127,7 @@ from ...types.referral_list import ReferralList
 from ...types.affiliate_invite import AffiliateInvite
 from ...types.participant_list import ParticipantList
 from ...types.campaign.campaign import Campaign
+from ...types.campaign.language import Language
 from ...types.affiliate_application import AffiliateApplication
 from ...types.campaign_list_response import CampaignListResponse
 from ...types.participant_payout_list import ParticipantPayoutList
@@ -439,6 +440,7 @@ class CampaignResource(SyncAPIResource):
         first_name: str | Omit = omit,
         ip_address: str | Omit = omit,
         is_affiliate: bool | Omit = omit,
+        language: Language | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
@@ -466,6 +468,9 @@ class CampaignResource(SyncAPIResource):
 
           is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages. Applied only when this request creates the participant.
+
           referred_by: Referrer participant ID or email address.
 
           extra_headers: Send extra headers
@@ -487,6 +492,7 @@ class CampaignResource(SyncAPIResource):
                     "first_name": first_name,
                     "ip_address": ip_address,
                     "is_affiliate": is_affiliate,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,
@@ -1665,6 +1671,7 @@ class AsyncCampaignResource(AsyncAPIResource):
         first_name: str | Omit = omit,
         ip_address: str | Omit = omit,
         is_affiliate: bool | Omit = omit,
+        language: Language | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
@@ -1692,6 +1699,9 @@ class AsyncCampaignResource(AsyncAPIResource):
 
           is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages. Applied only when this request creates the participant.
+
           referred_by: Referrer participant ID or email address.
 
           extra_headers: Send extra headers
@@ -1713,6 +1723,7 @@ class AsyncCampaignResource(AsyncAPIResource):
                     "first_name": first_name,
                     "ip_address": ip_address,
                     "is_affiliate": is_affiliate,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,

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

@@ -61,6 +61,10 @@ class EmailsResource(SyncAPIResource):
         (`subject`, `preheader`, `body`, `isEnabled`) plus the `settings` block (sender,
         contact, and design). The set of email templates returned depends on the program
         type (referral vs affiliate).
+        `followUpReminder` is disabled by default. It reminds the referrer about new
+        invitations sent while enabled when the contacts have not signed up.
+        `delayDays` accepts integers from 2 to 30 (default 3); changing it leaves
+        existing reminder dates unchanged.
 
         Args:
           extra_headers: Send extra headers
@@ -163,6 +167,10 @@ class AsyncEmailsResource(AsyncAPIResource):
         (`subject`, `preheader`, `body`, `isEnabled`) plus the `settings` block (sender,
         contact, and design). The set of email templates returned depends on the program
         type (referral vs affiliate).
+        `followUpReminder` is disabled by default. It reminds the referrer about new
+        invitations sent while enabled when the contacts have not signed up.
+        `delayDays` accepts integers from 2 to 30 (default 3); changing it leaves
+        existing reminder dates unchanged.
 
         Args:
           extra_headers: Send extra headers

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

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, Iterable, cast
+from typing import Any, Dict, Iterable, Optional, cast
 from typing_extensions import Literal
 
 import httpx
@@ -37,6 +37,7 @@ from ...types.campaign import (
     participant_request_payout_destination_confirmation_params,
 )
 from ...types.referral_list import ReferralList
+from ...types.campaign.language import Language
 from ...types.campaign.participant import Participant
 from ...types.participant_payout_list import ParticipantPayoutList
 from ...types.campaign.referral_status import ReferralStatus
@@ -129,6 +130,7 @@ class ParticipantResource(SyncAPIResource):
         affiliate_status: Literal["APPROVED", "SUSPENDED", "BANNED"] | Omit = omit,
         email: str | Omit = omit,
         first_name: str | Omit = omit,
+        language: Optional[Language] | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         notes: str | Omit = omit,
@@ -155,6 +157,10 @@ class ParticipantResource(SyncAPIResource):
               participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected for
               non-affiliates.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages (see `languages` in the program options). Send the base
+              language or `null` to use the program's base language.
+
           metadata: Shallow custom metadata object.
 
           notes: Freeform internal notes about the participant (internal only, never exposed to
@@ -185,6 +191,7 @@ class ParticipantResource(SyncAPIResource):
                     "affiliate_status": affiliate_status,
                     "email": email,
                     "first_name": first_name,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "notes": notes,
@@ -298,6 +305,7 @@ class ParticipantResource(SyncAPIResource):
         first_name: str | Omit = omit,
         ip_address: str | Omit = omit,
         is_affiliate: bool | Omit = omit,
+        language: Language | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
@@ -326,6 +334,9 @@ class ParticipantResource(SyncAPIResource):
               non-affiliate without `affiliateStatus`. Existing participants are returned
               unchanged.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages. Applied only when this request creates the participant.
+
           metadata: Shallow custom metadata object.
 
           mobile_instance_id: Optional app-install scoped identifier for native mobile anti-fraud. Recommended
@@ -358,6 +369,7 @@ class ParticipantResource(SyncAPIResource):
                     "first_name": first_name,
                     "ip_address": ip_address,
                     "is_affiliate": is_affiliate,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,
@@ -1019,7 +1031,7 @@ class ParticipantResource(SyncAPIResource):
         name, postal address, and an unsubscribe link are added automatically, and
         unsubscribed participants are suppressed). Sending requires the team to be
         verified by GrowSurf. Requires a **verified custom email domain** on the program
-        (which can be completed in *Campaign Editor > 3. Emails > Email Settings*).
+        (which can be completed in *Program Editor > 3. Emails > Email Settings*).
         Returns `400` until one is verified. The email is accepted for delivery.
 
         Args:
@@ -1032,6 +1044,8 @@ class ParticipantResource(SyncAPIResource):
               `commissionGenerated`, `commissionAdjusted`, `payoutPending`, `payoutSentSuccess`,
               `progressUpdateMonthly`. System/transactional types (login link, PayPal confirmation,
               tax) and the invite email cannot be sent.
+              `welcomeNonReferred` can only be sent to advocates or approved, enrolled affiliates in
+              a program that has not ended.
 
           body: HTML body for a free-form email. You can personalize it with dynamic text, inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`. See [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
 
@@ -1395,6 +1409,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         affiliate_status: Literal["APPROVED", "SUSPENDED", "BANNED"] | Omit = omit,
         email: str | Omit = omit,
         first_name: str | Omit = omit,
+        language: Optional[Language] | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         notes: str | Omit = omit,
@@ -1421,6 +1436,10 @@ class AsyncParticipantResource(AsyncAPIResource):
               participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected for
               non-affiliates.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages (see `languages` in the program options). Send the base
+              language or `null` to use the program's base language.
+
           metadata: Shallow custom metadata object.
 
           notes: Freeform internal notes about the participant (internal only, never exposed to
@@ -1451,6 +1470,7 @@ class AsyncParticipantResource(AsyncAPIResource):
                     "affiliate_status": affiliate_status,
                     "email": email,
                     "first_name": first_name,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "notes": notes,
@@ -1564,6 +1584,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         first_name: str | Omit = omit,
         ip_address: str | Omit = omit,
         is_affiliate: bool | Omit = omit,
+        language: Language | Omit = omit,
         last_name: str | Omit = omit,
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
@@ -1592,6 +1613,9 @@ class AsyncParticipantResource(AsyncAPIResource):
               non-affiliate without `affiliateStatus`. Existing participants are returned
               unchanged.
 
+          language: The language of the participant's portal and program emails. Must be one of the
+              program's languages. Applied only when this request creates the participant.
+
           metadata: Shallow custom metadata object.
 
           mobile_instance_id: Optional app-install scoped identifier for native mobile anti-fraud. Recommended
@@ -1624,6 +1648,7 @@ class AsyncParticipantResource(AsyncAPIResource):
                     "first_name": first_name,
                     "ip_address": ip_address,
                     "is_affiliate": is_affiliate,
+                    "language": language,
                     "last_name": last_name,
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,
@@ -2285,7 +2310,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         name, postal address, and an unsubscribe link are added automatically, and
         unsubscribed participants are suppressed). Sending requires the team to be
         verified by GrowSurf. Requires a **verified custom email domain** on the program
-        (which can be completed in *Campaign Editor > 3. Emails > Email Settings*).
+        (which can be completed in *Program Editor > 3. Emails > Email Settings*).
         Returns `400` until one is verified. The email is accepted for delivery.
 
         Args:
@@ -2298,6 +2323,8 @@ class AsyncParticipantResource(AsyncAPIResource):
               `commissionGenerated`, `commissionAdjusted`, `payoutPending`, `payoutSentSuccess`,
               `progressUpdateMonthly`. System/transactional types (login link, PayPal confirmation,
               tax) and the invite email cannot be sent.
+              `welcomeNonReferred` can only be sent to advocates or approved, enrolled affiliates in
+              a program that has not ended.
 
           body: HTML body for a free-form email. You can personalize it with dynamic text, inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`. See [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
 

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

@@ -58,8 +58,8 @@ class RewardResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardDeleteResponse:
         """
-        Removes a manually approved participant reward that has not already been
-        approved.
+        Removes a participant reward that requires manual approval and has not yet
+        been approved.
 
         Args:
           extra_headers: Send extra headers
@@ -96,7 +96,7 @@ class RewardResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardApproveResponse:
         """
-        Approves a manually approved reward earned by a participant. This requires
+        Approves a participant reward that requires manual approval. This requires
         `reward:write`. When the request also sets `fulfill` to `true`, it additionally
         requires `reward:fulfill`.
 
@@ -196,8 +196,8 @@ class AsyncRewardResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardDeleteResponse:
         """
-        Removes a manually approved participant reward that has not already been
-        approved.
+        Removes a participant reward that requires manual approval and has not yet
+        been approved.
 
         Args:
           extra_headers: Send extra headers
@@ -234,7 +234,7 @@ class AsyncRewardResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardApproveResponse:
         """
-        Approves a manually approved reward earned by a participant. This requires
+        Approves a participant reward that requires manual approval. This requires
         `reward:write`. When the request also sets `fulfill` to `true`, it additionally
         requires `reward:fulfill`.
 

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/__init__.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from .reward import Reward as Reward
 from .webhook import Webhook as Webhook
 from .campaign import Campaign as Campaign
+from .language import Language as Language
 from .integration import Integration as Integration
 from .participant import Participant as Participant
 from .webhook_event import WebhookEvent as WebhookEvent

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/campaign_emails.py

@@ -9,7 +9,13 @@ __all__ = ["CampaignEmails"]
 # each editable email template plus the shared `settings` block. The set of
 # templates depends on the program type; it is intentionally modeled as a loose
 # object. `offerClaimed` is available to both program types and sends while the
-# Claim Offer Popup is enabled. To see the full object with every field and its
+# Claim Offer Popup is enabled. `followUpReminder` is disabled by default and
+# reminds the referrer about new invitations sent while it is enabled when the
+# contacts have not signed up. Its `delayDays` is an integer from 2 to 30 (default
+# 3); changing it leaves existing reminder dates unchanged.
+# 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.
+# change. New programs return settings.design.layoutMode="INLINE" (read-only).
+# Their bodies require {{emailFooter}}; {{emailHeader}} is optional. Older programs
+# omit layoutMode and keep their existing layout.
 CampaignEmails: TypeAlias = Dict[str, object]

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

@@ -8,8 +8,9 @@ __all__ = ["CampaignOptions"]
 # A program's options (the dashboard Program Editor's Options tab): reward/fraud
 # 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), and notification-
-# email settings. It is intentionally modeled as a loose object. To see the full
+# 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
 # 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/src/growsurf/types/campaign/language.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["Language"]
+
+# A language a program can run in. Participants see the portal and receive program
+# emails in their language.
+Language: TypeAlias = Literal["en", "es", "fr", "de", "it", "pt-BR", "nl", "pl", "sv", "tr", "ja", "ko", "zh-CN", "id"]

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/participant.py

@@ -5,6 +5,7 @@ from typing_extensions import Literal
 
 from pydantic import Field as FieldInfo
 
+from .language import Language
 from ..._models import BaseModel
 from .referral_source import ReferralSource
 from .referral_status import ReferralStatus
@@ -149,6 +150,13 @@ class Participant(BaseModel):
 
     is_winner: Optional[bool] = FieldInfo(alias="isWinner", default=None)
 
+    language: Optional[Language] = None
+    """The language of the participant's portal and program emails.
+
+    The program's base language unless the participant (or you) picked another of the
+    program's languages.
+    """
+
     last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
 
     lead_count: Optional[int] = FieldInfo(alias="leadCount", default=None)

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/participant_add_params.py

@@ -6,6 +6,7 @@ from typing import Dict
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
+from .language import Language
 
 __all__ = ["ParticipantAddParams"]
 
@@ -27,6 +28,13 @@ class ParticipantAddParams(TypedDict, total=False):
     unchanged.
     """
 
+    language: Language
+    """The language of the participant's portal and program emails.
+
+    Must be one of the program's languages. Applied only when this request creates
+    the participant.
+    """
+
     last_name: Annotated[str, PropertyInfo(alias="lastName")]
 
     metadata: Dict[str, object]

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/participant_email_params.py

@@ -23,6 +23,8 @@ class ParticipantEmailParams(TypedDict, total=False):
     `commissionGenerated`, `commissionAdjusted`, `payoutPending`, `payoutSentSuccess`,
     `progressUpdateMonthly`. System/transactional types (login link, PayPal confirmation,
     tax) and the invite email cannot be sent.
+    `welcomeNonReferred` can only be sent to advocates or approved, enrolled affiliates in a program
+    that has not ended.
     """
 
     body: str

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign/participant_update_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
-from typing import Dict
+from typing import Dict, Optional
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
+from .language import Language
 
 __all__ = ["ParticipantUpdateParams"]
 
@@ -25,6 +26,13 @@ class ParticipantUpdateParams(TypedDict, total=False):
 
     first_name: Annotated[str, PropertyInfo(alias="firstName")]
 
+    language: Optional[Language]
+    """The language of the participant's portal and program emails.
+
+    Must be one of the program's languages (see `languages` in the program options).
+    Send the base language or `null` to use the program's base language.
+    """
+
     last_name: Annotated[str, PropertyInfo(alias="lastName")]
 
     metadata: Dict[str, object]

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/src/growsurf/types/campaign_create_mobile_participant_token_params.py

@@ -6,6 +6,7 @@ from typing import Dict
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .campaign.language import Language
 
 __all__ = ["CampaignCreateMobileParticipantTokenParams"]
 
@@ -27,6 +28,13 @@ class CampaignCreateMobileParticipantTokenParams(TypedDict, total=False):
     unchanged.
     """
 
+    language: Language
+    """The language of the participant's portal and program emails.
+
+    Must be one of the program's languages. Applied only when this request creates
+    the participant.
+    """
+
     last_name: Annotated[str, PropertyInfo(alias="lastName")]
 
     metadata: Dict[str, object]

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/tests/api_resources/campaign/test_participant.py

@@ -104,6 +104,7 @@ class TestParticipant:
             id="id",
             email="dev@stainless.com",
             first_name="Gavin",
+            language="es",
             last_name="Belson",
             metadata={"company": "bar"},
             notes="notes",
@@ -278,6 +279,7 @@ class TestParticipant:
             first_name="firstName",
             ip_address="ipAddress",
             is_affiliate=True,
+            language="es",
             last_name="lastName",
             metadata={"foo": "bar"},
             mobile_instance_id="mobileInstanceId",
@@ -1344,6 +1346,7 @@ class TestAsyncParticipant:
             id="id",
             email="dev@stainless.com",
             first_name="Gavin",
+            language="es",
             last_name="Belson",
             metadata={"company": "bar"},
             notes="notes",
@@ -1518,6 +1521,7 @@ class TestAsyncParticipant:
             first_name="firstName",
             ip_address="ipAddress",
             is_affiliate=True,
+            language="es",
             last_name="lastName",
             metadata={"foo": "bar"},
             mobile_instance_id="mobileInstanceId",

{growsurf_python-1.11.0 → growsurf_python-1.13.0}/tests/api_resources/test_campaign.py

@@ -318,6 +318,7 @@ class TestCampaign:
             fingerprint="fingerprint",
             first_name="firstName",
             ip_address="ipAddress",
+            language="es",
             last_name="lastName",
             metadata={"foo": "bar"},
             mobile_instance_id="mobileInstanceId",
@@ -1382,6 +1383,7 @@ class TestAsyncCampaign:
             fingerprint="fingerprint",
             first_name="firstName",
             ip_address="ipAddress",
+            language="es",
             last_name="lastName",
             metadata={"foo": "bar"},
             mobile_instance_id="mobileInstanceId",