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

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

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

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

@@ -1,5 +1,12 @@
 # Changelog
 
+## [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.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.2.0
+Version: 1.2.1
 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

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

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

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

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/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.

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/campaign.py

@@ -196,9 +196,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Campaign:
         """
-        Creates a new program pre-populated with type-appropriate defaults, plus any
-        optional inline rewards. The new program is created in `DRAFT` status and owned
-        by the API key's bound team. Requires the team owner's verified email.
+        Creates a new program, plus any optional program rewards. The new program is
+        created in `DRAFT` status and owned by the API key's bound team.
 
         Args:
           type: The program type. Immutable after creation.
@@ -289,8 +288,8 @@ class CampaignResource(SyncAPIResource):
         Updates a program's identity and lifecycle. Only the fields you send are
         changed. `type`, `urlId`, and `currencyISO` are immutable. Editor-tab
         configuration (design, emails, options, installation) is edited via the
-        dedicated config sub-resources, not here. The program cannot be deleted via
-        this endpoint.
+        dedicated config sub-resources, not here. The program cannot be deleted via this
+        endpoint.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -458,7 +457,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantCommissionList:
         """
-        Retrieves a paged list of all participant commissions in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant
+        commissions in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -628,7 +628,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantPayoutList:
         """
-        Retrieves a paged list of all participant payouts in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant payouts
+        in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -762,10 +763,9 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignRetrieveAnalyticsResponse:
         """
-        Retrieves analytics for a program. Pass ``interval`` to also get a time-series
-        (``series``) alongside the totals, and ``include`` to add previous-period
-        totals, status breakdowns, or derived rates — useful for detecting trends over
-        time.
+        Retrieves analytics for a program. Pass `interval` to also get a time-series
+        (`series`) alongside the totals, and `include` to add previous-period totals,
+        status breakdowns, or derived rates — useful for detecting trends over time.
 
         Args:
           days: Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
@@ -898,9 +898,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Campaign:
         """
-        Creates a new program pre-populated with type-appropriate defaults, plus any
-        optional inline rewards. The new program is created in `DRAFT` status and owned
-        by the API key's bound team. Requires the team owner's verified email.
+        Creates a new program, plus any optional program rewards. The new program is
+        created in `DRAFT` status and owned by the API key's bound team.
 
         Args:
           type: The program type. Immutable after creation.
@@ -991,8 +990,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         Updates a program's identity and lifecycle. Only the fields you send are
         changed. `type`, `urlId`, and `currencyISO` are immutable. Editor-tab
         configuration (design, emails, options, installation) is edited via the
-        dedicated config sub-resources, not here. The program cannot be deleted via
-        this endpoint.
+        dedicated config sub-resources, not here. The program cannot be deleted via this
+        endpoint.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -1160,7 +1159,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantCommissionList:
         """
-        Retrieves a paged list of all participant commissions in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant
+        commissions in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -1330,7 +1330,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantPayoutList:
         """
-        Retrieves a paged list of all participant payouts in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant payouts
+        in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -1464,10 +1465,9 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignRetrieveAnalyticsResponse:
         """
-        Retrieves analytics for a program. Pass ``interval`` to also get a time-series
-        (``series``) alongside the totals, and ``include`` to add previous-period
-        totals, status breakdowns, or derived rates — useful for detecting trends over
-        time.
+        Retrieves analytics for a program. Pass `interval` to also get a time-series
+        (`series`) alongside the totals, and `include` to add previous-period totals,
+        status breakdowns, or derived rates — useful for detecting trends over time.
 
         Args:
           days: Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/commission.py

@@ -56,7 +56,7 @@ class CommissionResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionDeleteResponse:
         """
-        Removes a pending participant commission.
+        **Affiliate programs only.** Removes a pending participant commission.
 
         Args:
           extra_headers: Send extra headers
@@ -92,7 +92,8 @@ class CommissionResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionApproveResponse:
         """
-        Approves a pending participant commission so it can become eligible for payout.
+        **Affiliate programs only.** Approves a pending participant commission so it can
+        become eligible for payout.
 
         Args:
           extra_headers: Send extra headers
@@ -151,7 +152,7 @@ class AsyncCommissionResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionDeleteResponse:
         """
-        Removes a pending participant commission.
+        **Affiliate programs only.** Removes a pending participant commission.
 
         Args:
           extra_headers: Send extra headers
@@ -187,7 +188,8 @@ class AsyncCommissionResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionApproveResponse:
         """
-        Approves a pending participant commission so it can become eligible for payout.
+        **Affiliate programs only.** Approves a pending participant commission so it can
+        become eligible for payout.
 
         Args:
           extra_headers: Send extra headers

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/design.py

@@ -57,9 +57,11 @@ class DesignResource(SyncAPIResource):
     ) -> CampaignDesign:
         """
         Retrieves a program's design configuration — the same surface as the dashboard
-        Program Editor's **Design** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Program Editor's **Design** tab: the GrowSurf window layout, header, share
+        channels + invite, signup form, portal/landing pages, theme styling, and the
+        referral/affiliate summary + status sections. This is a large object whose
+        available fields depend on the program type; the response includes every field
+        and its current value, which is the same shape you send back on `PATCH`.
 
         Args:
           extra_headers: Send extra headers
@@ -96,9 +98,8 @@ class DesignResource(SyncAPIResource):
         Updates a program's design configuration. Only the fields you send are changed;
         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`. To see the full `CampaignDesign` object with every
-        field and its current value, `GET` this resource first, then `PATCH` back only the
-        fields you want to change.
+        invalid values return a `400`. Landing-page custom code and JavaScript are not
+        editable via the API.
 
         Args:
           body: A partial `CampaignDesign` object — only the fields you send are changed.
@@ -158,9 +159,11 @@ class AsyncDesignResource(AsyncAPIResource):
     ) -> CampaignDesign:
         """
         Retrieves a program's design configuration — the same surface as the dashboard
-        Program Editor's **Design** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Program Editor's **Design** tab: the GrowSurf window layout, header, share
+        channels + invite, signup form, portal/landing pages, theme styling, and the
+        referral/affiliate summary + status sections. This is a large object whose
+        available fields depend on the program type; the response includes every field
+        and its current value, which is the same shape you send back on `PATCH`.
 
         Args:
           extra_headers: Send extra headers
@@ -197,9 +200,8 @@ class AsyncDesignResource(AsyncAPIResource):
         Updates a program's design configuration. Only the fields you send are changed;
         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`. To see the full `CampaignDesign` object with every
-        field and its current value, `GET` this resource first, then `PATCH` back only the
-        fields you want to change.
+        invalid values return a `400`. Landing-page custom code and JavaScript are not
+        editable via the API.
 
         Args:
           body: A partial `CampaignDesign` object — only the fields you send are changed.

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/emails.py

@@ -56,10 +56,11 @@ class EmailsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignEmails:
         """
-        Retrieves a program's emails configuration — the same surface as the dashboard
-        Program Editor's **Emails** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Retrieves a program's email configuration — the same surface as the dashboard
+        Program Editor's **Emails** tab. Returns each editable email template
+        (`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).
 
         Args:
           extra_headers: Send extra headers
@@ -95,12 +96,10 @@ class EmailsResource(SyncAPIResource):
         """
         Updates a program's email configuration. Only the fields you send are changed;
         omitted fields are left untouched. You may only write the email templates the
-        dashboard exposes for the program type — writing a template that is not available
-        for the program type returns a `400`. Some fields are read-only
+        dashboard exposes for the program type — writing a template that is not
+        available for the program type returns a `400`. Some fields are read-only
         (`settings.sender.fromEmail`, whose custom value requires dashboard domain
-        verification). To see the full `CampaignEmails` object with every field and its
-        current value, `GET` this resource first, then `PATCH` back only the fields you
-        want to change.
+        verification).
 
         Args:
           body: A partial `CampaignEmails` object — only the fields you send are changed.
@@ -159,10 +158,11 @@ class AsyncEmailsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignEmails:
         """
-        Retrieves a program's emails configuration — the same surface as the dashboard
-        Program Editor's **Emails** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Retrieves a program's email configuration — the same surface as the dashboard
+        Program Editor's **Emails** tab. Returns each editable email template
+        (`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).
 
         Args:
           extra_headers: Send extra headers
@@ -198,12 +198,10 @@ class AsyncEmailsResource(AsyncAPIResource):
         """
         Updates a program's email configuration. Only the fields you send are changed;
         omitted fields are left untouched. You may only write the email templates the
-        dashboard exposes for the program type — writing a template that is not available
-        for the program type returns a `400`. Some fields are read-only
+        dashboard exposes for the program type — writing a template that is not
+        available for the program type returns a `400`. Some fields are read-only
         (`settings.sender.fromEmail`, whose custom value requires dashboard domain
-        verification). To see the full `CampaignEmails` object with every field and its
-        current value, `GET` this resource first, then `PATCH` back only the fields you
-        want to change.
+        verification).
 
         Args:
           body: A partial `CampaignEmails` object — only the fields you send are changed.

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/installation.py

@@ -56,10 +56,10 @@ class InstallationResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignInstallation:
         """
-        Retrieves a program's installation configuration — the same surface as the dashboard
-        Program Editor's **Installation** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Retrieves a program's installation configuration — the same surface as the
+        dashboard Program Editor's **Installation** tab (plus the Mobile SDK settings).
+        Includes the referral trigger (referral programs only), signup tracking method,
+        share URL and whitelist, custom-form signup settings, and mobile SDK settings.
 
         Args:
           extra_headers: Send extra headers
@@ -95,10 +95,10 @@ class InstallationResource(SyncAPIResource):
         """
         Updates a program's installation configuration. Only the fields you send are
         changed; omitted fields are left untouched. `referralTrigger` is only available
-        for referral programs. `mobile.publicKey` is read-only (server-generated). URLs
-        must include an explicit `http://` or `https://` scheme. To see the full
-        `CampaignInstallation` object with every field and its current value, `GET` this
-        resource first, then `PATCH` back only the fields you want to change.
+        for referral programs. `mobile.publicKey` is read-only; if no key exists yet,
+        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.
 
         Args:
           body: A partial `CampaignInstallation` object — only the fields you send are changed.
@@ -157,10 +157,10 @@ class AsyncInstallationResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignInstallation:
         """
-        Retrieves a program's installation configuration — the same surface as the dashboard
-        Program Editor's **Installation** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        Retrieves a program's installation configuration — the same surface as the
+        dashboard Program Editor's **Installation** tab (plus the Mobile SDK settings).
+        Includes the referral trigger (referral programs only), signup tracking method,
+        share URL and whitelist, custom-form signup settings, and mobile SDK settings.
 
         Args:
           extra_headers: Send extra headers
@@ -196,10 +196,10 @@ class AsyncInstallationResource(AsyncAPIResource):
         """
         Updates a program's installation configuration. Only the fields you send are
         changed; omitted fields are left untouched. `referralTrigger` is only available
-        for referral programs. `mobile.publicKey` is read-only (server-generated). URLs
-        must include an explicit `http://` or `https://` scheme. To see the full
-        `CampaignInstallation` object with every field and its current value, `GET` this
-        resource first, then `PATCH` back only the fields you want to change.
+        for referral programs. `mobile.publicKey` is read-only; if no key exists yet,
+        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.
 
         Args:
           body: A partial `CampaignInstallation` object — only the fields you send are changed.

{growsurf_python-1.2.0 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/options.py

@@ -56,10 +56,11 @@ class OptionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Retrieves a program's options configuration — the same surface as the dashboard
-        Program Editor's **Options** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        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, payout threshold + tax
+        settings (affiliate only), and notification-email settings.
+        `fraud.recaptcha.secretKey` is never returned.
 
         Args:
           extra_headers: Send extra headers
@@ -93,14 +94,12 @@ class OptionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Updates a program's options. Only the fields you send are changed. Some fields are
-        program-type specific (`requireManualRewardApproval`/`autoFulfillRewards` are
-        referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
+        Updates a program's options. Only the fields you send are changed. Some fields
+        are program-type specific (`requireManualRewardApproval`/`autoFulfillRewards`
+        are referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
         affiliate programs require `requireParticipantAuth: true`).
-        `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null` means
-        "never expires". To see the full `CampaignOptions` object with every field and its
-        current value, `GET` this resource first, then `PATCH` back only the fields you
-        want to change.
+        `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null`
+        means "never expires".
 
         Args:
           body: A partial `CampaignOptions` object — only the fields you send are changed.
@@ -159,10 +158,11 @@ class AsyncOptionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Retrieves a program's options configuration — the same surface as the dashboard
-        Program Editor's **Options** tab. This is a large object whose available fields
-        depend on the program type; the response includes every field and its current
-        value, which is the same shape you send back on `PATCH`.
+        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, payout threshold + tax
+        settings (affiliate only), and notification-email settings.
+        `fraud.recaptcha.secretKey` is never returned.
 
         Args:
           extra_headers: Send extra headers
@@ -196,14 +196,12 @@ class AsyncOptionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignOptions:
         """
-        Updates a program's options. Only the fields you send are changed. Some fields are
-        program-type specific (`requireManualRewardApproval`/`autoFulfillRewards` are
-        referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
+        Updates a program's options. Only the fields you send are changed. Some fields
+        are program-type specific (`requireManualRewardApproval`/`autoFulfillRewards`
+        are referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
         affiliate programs require `requireParticipantAuth: true`).
-        `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null` means
-        "never expires". To see the full `CampaignOptions` object with every field and its
-        current value, `GET` this resource first, then `PATCH` back only the fields you
-        want to change.
+        `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null`
+        means "never expires".
 
         Args:
           body: A partial `CampaignOptions` object — only the fields you send are changed.