growsurf-python 1.10.0__tar.gz → 1.12.0__tar.gz

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

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

{growsurf_python-1.10.0 → growsurf_python-1.12.0}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* **api:** update campaign contracts ([0351056](https://github.com/growsurf/growsurf-python/commit/03510565276942c3fe56ed8cd91e2547a88dff54))
+
 ## [1.10.0](https://github.com/growsurf/growsurf-python/compare/v1.9.0...v1.10.0) (2026-09-23)
 
 

{growsurf_python-1.10.0 → growsurf_python-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.10.0
+Version: 1.12.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.10.0 → growsurf_python-1.12.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
 

{growsurf_python-1.10.0 → growsurf_python-1.12.0}/pyproject.toml

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

{growsurf_python-1.10.0 → growsurf_python-1.12.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.10.0"  # x-release-please-version
+__version__ = "1.12.0"  # x-release-please-version

{growsurf_python-1.10.0 → growsurf_python-1.12.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.10.0 → growsurf_python-1.12.0}/src/growsurf/resources/campaign/participant.py

@@ -1032,6 +1032,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).
 
@@ -1278,7 +1280,7 @@ class ParticipantResource(SyncAPIResource):
         participant_id_or_email: str,
         *,
         id: str,
-        provider: Literal["PAYPAL", "WISECOM"],
+        provider: Literal["PAYPAL", "VENMO", "WISECOM"],
         # 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,
@@ -2298,6 +2300,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).
 
@@ -2544,7 +2548,7 @@ class AsyncParticipantResource(AsyncAPIResource):
         participant_id_or_email: str,
         *,
         id: str,
-        provider: Literal["PAYPAL", "WISECOM"],
+        provider: Literal["PAYPAL", "VENMO", "WISECOM"],
         # 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,

{growsurf_python-1.10.0 → growsurf_python-1.12.0}/src/growsurf/resources/campaign/rewards.py

@@ -329,7 +329,8 @@ class RewardsResource(SyncAPIResource):
         """
         Retrieves configured Campaign Rewards, including switched-off rewards and rewards
         whose group is not selected. Deleted rewards are excluded. The campaign response's
-        embedded rewards array includes only enabled, visible rewards.
+        embedded `rewards` array includes only enabled, visible rewards. A reward can be earned only
+        when it also appears in the campaign response's embedded `rewards` array.
 
         Args:
           extra_headers: Send extra headers
@@ -694,7 +695,8 @@ class AsyncRewardsResource(AsyncAPIResource):
         """
         Retrieves configured Campaign Rewards, including switched-off rewards and rewards
         whose group is not selected. Deleted rewards are excluded. The campaign response's
-        embedded rewards array includes only enabled, visible rewards.
+        embedded `rewards` array includes only enabled, visible rewards. A reward can be earned only
+        when it also appears in the campaign response's embedded `rewards` array.
 
         Args:
           extra_headers: Send extra headers

{growsurf_python-1.10.0 → growsurf_python-1.12.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.10.0 → growsurf_python-1.12.0}/src/growsurf/types/campaign/campaign_installation.py

@@ -7,7 +7,8 @@ __all__ = ["CampaignInstallation"]
 
 # A program's installation configuration (the dashboard Program Editor's
 # Installation tab, plus Mobile SDK settings): referral trigger, signup
-# tracking, share URL + whitelist, custom-form signup, and mobile SDK settings.
+# tracking, share URL + whitelist, custom-form signup, mobile SDK settings,
+# and saved installation-guide choices (`instructionSelections`).
 # 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.

{growsurf_python-1.10.0 → growsurf_python-1.12.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.10.0 → growsurf_python-1.12.0}/src/growsurf/types/campaign/participant_request_payout_destination_confirmation_params.py

@@ -10,5 +10,5 @@ __all__ = ["ParticipantRequestPayoutDestinationConfirmationParams"]
 class ParticipantRequestPayoutDestinationConfirmationParams(TypedDict, total=False):
     id: Required[str]
 
-    provider: Required[Literal["PAYPAL", "WISECOM"]]
+    provider: Required[Literal["PAYPAL", "VENMO", "WISECOM"]]
     """The payout provider the participant should confirm a destination for."""