growsurf-ruby 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8076462c15a156d463bf26bb5f654d2baf7a6795204be7b8ef79a9dd2ae2053
-  data.tar.gz: da320558ee220ff66aac11869a410cdcb402084b9563985763da99c47cce1755
+  metadata.gz: d3f7355b6a4f09692cd4f02923eda76fe0887f88b647f0cfdc461b93e36337f6
+  data.tar.gz: 16ae21e1f33b5f0ffead7caf1f93d80758fbffce09c3d634d0350f5cde7e1e36
 SHA512:
-  metadata.gz: d5c1d9647d05936815ddae19a40e12a06cf4d1ed469f27c86dc03b543b3abd9895923e494c4bb0f7a28ba50c0c219bafa78276c0feb15d94f08b43d40b59f908
-  data.tar.gz: fe5bcdf5683be8d8dbf038f33ca365d66d5959f5c3d3a5b7e9c8e9717e0970564d8d5ac9b6d625bbf1af24edda057405aacefd9f4a35e6cd7c48f2aac1023a51
+  metadata.gz: c58b6e6dd858d7c7e419bd5d96d605b27d8de8518d3c9c2ff2c4dd121473404a6843f0e62dc6c4b0190c02ae7bed3821542b73ab5ebf9bf3646ee343783a92ee
+  data.tar.gz: d98124e2a70ebb54f25757c814342a2ee6f4d5595c3713ebb26386b9157474eaee6ad35825ad091f5b180455d89d9a334972fd37e53593c1c066d3d3d7b7f553

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.2.1](https://github.com/growsurf/growsurf-ruby/compare/v1.2.0...v1.2.1) (2026-07-14)
+
+
+### Bug Fixes
+
+* align method docs with the REST v2 contract ([11967f2](https://github.com/growsurf/growsurf-ruby/commit/11967f2d1b95266e921775b921db970fc11e3cbb))
+
+## [1.2.0](https://github.com/growsurf/growsurf-ruby/compare/v1.1.2...v1.2.0) (2026-07-13)
+
+
+### Features
+
+* **api:** add Team resource ([8b11d89](https://github.com/growsurf/growsurf-ruby/commit/8b11d89403a00bb2c381dd46295252d929d48370))
+
 ## [1.1.2](https://github.com/growsurf/growsurf-ruby/compare/v1.1.1...v1.1.2) (2026-07-11)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "growsurf-ruby", "~> 1.1.2"
+gem "growsurf-ruby", "~> 1.2.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/client.rb

@@ -22,6 +22,9 @@ module GrowsurfRuby
     # @return [GrowsurfRuby::Resources::Account]
     attr_reader :account
 
+    # @return [GrowsurfRuby::Resources::Team]
+    attr_reader :team
+
     # @return [GrowsurfRuby::Resources::Campaign]
     attr_reader :campaign
 
@@ -59,10 +62,6 @@ module GrowsurfRuby
     )
       base_url ||= "https://api.growsurf.com/v2"
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"GROWSURF_API_KEY\"")
-      end
-
       headers = {}
       custom_headers_env = ENV["GROWSURF_CUSTOM_HEADERS"]
       unless custom_headers_env.nil?
@@ -76,7 +75,7 @@ module GrowsurfRuby
         headers = parsed.merge(headers)
       end
 
-      @api_key = api_key.to_s
+      @api_key = api_key&.to_s
 
       super(
         base_url: base_url,
@@ -89,6 +88,7 @@ module GrowsurfRuby
       )
 
       @account = GrowsurfRuby::Resources::Account.new(client: self)
+      @team = GrowsurfRuby::Resources::Team.new(client: self)
       @campaign = GrowsurfRuby::Resources::Campaign.new(client: self)
     end
   end

data/lib/growsurf_ruby/models/account_create_response.rb

@@ -14,18 +14,13 @@ module GrowsurfRuby
       required :api_key, String, api_name: :apiKey
 
       # @!attribute email
+      #   Email address for the new account.
       #
       #   @return [String]
       required :email, String
 
-      # @!attribute id
-      #   The new account's unique identifier.
-      #
-      #   @return [String]
-      required :id, String
-
       # @!attribute verification_status
-      #   GrowSurf account verification state. `VERIFIED` is required before a program
+      #   GrowSurf team verification state. `VERIFIED` is required before a program
       #   can send participant emails.
       #
       #   @return [Symbol, GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus]
@@ -33,7 +28,7 @@ module GrowsurfRuby
                enum: -> { GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus },
                api_name: :verificationStatus
 
-      # @!method initialize(api_key:, email:, id:, verification_status:)
+      # @!method initialize(api_key:, email:, verification_status:)
       #   Some parameter documentations has been truncated, see
       #   {GrowsurfRuby::Models::AccountCreateResponse} for more details.
       #
@@ -41,11 +36,9 @@ module GrowsurfRuby
       #
       #   @param email [String]
       #
-      #   @param id [String] The new account's unique identifier.
-      #
-      #   @param verification_status [Symbol, GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus] GrowSurf account verification state. `VERIFIED` is required before a program can
+      #   @param verification_status [Symbol, GrowsurfRuby::Models::AccountCreateResponse::VerificationStatus] GrowSurf team verification state. `VERIFIED` is required before a program can
 
-      # GrowSurf account verification state. `VERIFIED` is required before a program
+      # GrowSurf team verification state. `VERIFIED` is required before a program
       # can send participant emails.
       #
       # @see GrowsurfRuby::Models::AccountCreateResponse#verification_status

data/lib/growsurf_ruby/models/team.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Team#retrieve
+    class Team < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute name
+      #   The team's display name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute verification_status
+      #   GrowSurf team verification state. `VERIFIED` is required before a program can
+      #   send participant emails.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::Team::VerificationStatus]
+      required :verification_status,
+               enum: -> { GrowsurfRuby::Models::Team::VerificationStatus },
+               api_name: :verificationStatus
+
+      # @!attribute verification_requested_at
+      #   When team verification was last requested, as a Unix timestamp in milliseconds.
+      #
+      #   @return [Integer, nil]
+      required :verification_requested_at, Integer, api_name: :verificationRequestedAt, nil?: true
+
+      # @!method initialize(name:, verification_status:, verification_requested_at:)
+      #   @param name [String] The team's display name.
+      #
+      #   @param verification_status [Symbol, GrowsurfRuby::Models::Team::VerificationStatus] GrowSurf team verification state.
+      #
+      #   @param verification_requested_at [Integer, nil] When team verification was last requested, as a Unix timestamp in milliseconds.
+
+      # GrowSurf team verification state.
+      module VerificationStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NOT_REQUESTED = :NOT_REQUESTED
+        REQUESTED = :REQUESTED
+        VERIFIED = :VERIFIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/team_resend_owner_verification_email_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Team#resend_owner_verification_email
+    class TeamResendOwnerVerificationEmailResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute status
+      #   Status of the verification email request.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::TeamResendOwnerVerificationEmailResponse::Status]
+      required :status, enum: -> { GrowsurfRuby::Models::TeamResendOwnerVerificationEmailResponse::Status }
+
+      # @!attribute success
+      #   Whether the verification email request was accepted.
+      #
+      #   @return [Boolean]
+      required :success, GrowsurfRuby::Internal::Type::Boolean
+
+      # @!method initialize(status:, success:)
+      #   @param status [Symbol, GrowsurfRuby::Models::TeamResendOwnerVerificationEmailResponse::Status]
+      #
+      #   @param success [Boolean]
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        SENT = :SENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/{account_rotate_api_key_response.rb → team_rotate_api_key_response.rb}

@@ -2,8 +2,8 @@
 
 module GrowsurfRuby
   module Models
-    # @see GrowsurfRuby::Resources::Account#rotate_api_key
-    class AccountRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
+    # @see GrowsurfRuby::Resources::Team#rotate_api_key
+    class TeamRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
       # @!attribute api_key
       #   The new API key. Store it now; the key used for rotation stops working immediately.
       #
@@ -11,7 +11,7 @@ module GrowsurfRuby
       required :api_key, String, api_name: :apiKey
 
       # @!method initialize(api_key:)
-      #   @param api_key [String] The new API key. Store it now; the key used for rotation stops working immediately.
+      #   @param api_key [String] The new API key.
     end
   end
 end

data/lib/growsurf_ruby/models/team_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Team#update
+    class TeamUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The team's display name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:, request_options: {})
+      #   @param name [String] The team's display name.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models.rb

@@ -39,11 +39,11 @@ module GrowsurfRuby
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  Account = GrowsurfRuby::Models::Account
-
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
-  AccountUpdateParams = GrowsurfRuby::Models::AccountUpdateParams
+  Team = GrowsurfRuby::Models::Team
+
+  TeamUpdateParams = GrowsurfRuby::Models::TeamUpdateParams
 
   Campaign = GrowsurfRuby::Models::Campaign
 

data/lib/growsurf_ruby/resources/account.rb

@@ -4,30 +4,29 @@ module GrowsurfRuby
   module Resources
     class Account
       # 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 account's email address is
-      # verified: authenticated endpoints outside the `Accounts` group return a `403`
-      # with error code
-      # `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
-      # /account/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 the GrowSurf team to verify the account
-      # 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).
+      # 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).
       #
       # @overload create(email:, company: nil, first_name: nil, last_name: nil, request_options: {})
       #
-      # @param email [String] The email address for the new account. Personal emails and disposable email addresses are not accepted.
+      # @param email [String] The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.
       #
-      # @param company [String]
+      # @param company [String] Company name for the new account.
       #
-      # @param first_name [String]
+      # @param first_name [String] First name for the new account owner.
       #
-      # @param last_name [String]
+      # @param last_name [String] Last name for the new account owner.
       #
       # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -36,6 +35,7 @@ module GrowsurfRuby
       # @see GrowsurfRuby::Models::AccountCreateParams
       def create(params)
         parsed, options = GrowsurfRuby::AccountCreateParams.dump_request(params)
+        options[:extra_headers] = options[:extra_headers].to_h.merge("authorization" => nil)
         @client.request(
           method: :post,
           path: "accounts",
@@ -45,112 +45,6 @@ module GrowsurfRuby
         )
       end
 
-      # Retrieves the account that owns the API key: profile and GrowSurf-team
-      # verification state.
-      # `verificationStatus` is `VERIFIED` once the GrowSurf team has verified the account
-      # — this is required before you can send participant emails from a program.
-      #
-      # @overload retrieve(request_options: {})
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::Account]
-      def retrieve(params = {})
-        @client.request(
-          method: :get,
-          path: "account",
-          model: GrowsurfRuby::Account,
-          options: params[:request_options]
-        )
-      end
-
-      # Updates your own account profile (`firstName`, `lastName`, `company`). Any other
-      # property is rejected with a `400` — in particular, the account `email` cannot be
-      # changed via the API, and billing/subscription is not editable here.
-      #
-      # @overload update(company: nil, first_name: nil, last_name: nil, request_options: {})
-      #
-      # @param company [String]
-      #
-      # @param first_name [String]
-      #
-      # @param last_name [String]
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::Account]
-      #
-      # @see GrowsurfRuby::Models::AccountUpdateParams
-      def update(params = {})
-        parsed, options = GrowsurfRuby::AccountUpdateParams.dump_request(params)
-        @client.request(
-          method: :patch,
-          path: "account",
-          body: parsed,
-          model: GrowsurfRuby::Account,
-          options: options
-        )
-      end
-
-      # Generates a new API key and invalidates the key used for the request. The SDK
-      # sends a retry-safe `Idempotency-Key`, so automatic retries return the same
-      # replacement. Store the returned key, then update every integration that used
-      # the old key. The account owner is notified by email whenever the key is rotated.
-      # Requires an API key with `api_key:rotate`. This operation is available only through
-      # the REST API or a GrowSurf API SDK, not through MCP.
-      #
-      # @overload rotate_api_key(request_options: {})
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::AccountRotateAPIKeyResponse]
-      def rotate_api_key(params = {})
-        @client.request(
-          method: :post,
-          path: "account/api-key",
-          model: GrowsurfRuby::Models::AccountRotateAPIKeyResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Requests GrowSurf-team verification of your account (required before a program can
-      # email its participants). Idempotent — calling it again while a request is pending
-      # does not create a duplicate. Returns the account with its updated
-      # `verificationStatus`.
-      #
-      # @overload request_verification(request_options: {})
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::Account]
-      def request_verification(params = {})
-        @client.request(
-          method: :post,
-          path: "account/verification-request",
-          model: GrowsurfRuby::Account,
-          options: params[:request_options]
-        )
-      end
-
-      # Resends the email-verification email to the account's email address. A `200`
-      # with `status: SENT` is only returned when an email was actually dispatched.
-      # Returns a `400` if the email is already verified, or a `429` if a verification
-      # email was sent too recently — wait a moment, then retry.
-      #
-      # @overload resend_verification_email(request_options: {})
-      #
-      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [GrowsurfRuby::Models::AccountResendVerificationEmailResponse]
-      def resend_verification_email(params = {})
-        @client.request(
-          method: :post,
-          path: "account/verification-email",
-          model: GrowsurfRuby::Models::AccountResendVerificationEmailResponse,
-          options: params[:request_options]
-        )
-      end
-
       # @api private
       #
       # @param client [GrowsurfRuby::Client]

data/lib/growsurf_ruby/resources/campaign/commission.rb

@@ -5,7 +5,7 @@ module GrowsurfRuby
     class Campaign
       # Affiliate transaction, commission, and payout operations.
       class Commission
-        # Removes a pending participant commission.
+        # **Affiliate programs only.** Removes a pending participant commission.
         #
         # @overload delete(commission_id, id:, request_options: {})
         #
@@ -32,7 +32,8 @@ module GrowsurfRuby
           )
         end
 
-        # 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.
         #
         # @overload approve(commission_id, id:, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign/design.rb

@@ -5,12 +5,11 @@ module GrowsurfRuby
     class Campaign
       class Design
         # Retrieves a program's design configuration — the same surface as the dashboard
-        # Program Editor's **Design** tab (window layout, header, share channels, signup
-        # form, portal/landing pages, theme styling, and summary/status sections).
-        #
-        # This is a large, deeply nested 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 update.
+        # 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`.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -31,11 +30,8 @@ module GrowsurfRuby
         # 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`.
-        #
-        # The request body is a partial {CampaignDesign} object. To see the full object
-        # with every field and its current value, `GET` this resource, 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.
         #
         # @overload update(id, body, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign/emails.rb

@@ -5,11 +5,10 @@ module GrowsurfRuby
     class Campaign
       class Emails
         # Retrieves a program's email configuration — the same surface as the dashboard
-        # Program Editor's **Emails** tab (per-email templates plus sender, contact, and
-        # design settings).
-        #
-        # To see the full object with every field and its current value, `GET` this
-        # resource, then `PATCH` back only the fields you want to change.
+        # 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).
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -28,12 +27,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's email configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. Unknown fields and invalid values return a
-        # `400`.
-        #
-        # The request body is a partial {CampaignEmails} object. To see the full object
-        # with every field and its current value, `GET` this resource, then `PATCH` back
-        # only the fields you want to change.
+        # 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
+        # (`settings.sender.fromEmail`, whose custom value requires dashboard domain
+        # verification).
         #
         # @overload update(id, body, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign/installation.rb

@@ -5,12 +5,9 @@ module GrowsurfRuby
     class Campaign
       class Installation
         # Retrieves a program's installation configuration — the same surface as the
-        # dashboard Program Editor's **Installation** tab (signup and mobile SDK
-        # installation settings).
-        #
-        # This is a nested object whose available fields depend on the program type. To
-        # see the full object with every field and its current value, `GET` this
-        # resource, then `PATCH` back only the fields you want to change.
+        # 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.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -29,12 +26,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's installation configuration. Only the fields you send are
-        # changed; anything you leave out is untouched. Unknown fields, fields not
-        # available for the program type, and invalid values return a `400`.
-        #
-        # The request body is a partial {CampaignInstallation} object. To see the full
-        # object with every field and its current value, `GET` this resource, then
-        # `PATCH` back only the fields you want to change.
+        # changed; omitted fields are left untouched. `referralTrigger` is only available
+        # 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.
         #
         # @overload update(id, body, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign/options.rb

@@ -4,12 +4,11 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Options
-        # Retrieves a program's options configuration — the same surface as the dashboard
-        # Program Editor's **Options** tab (fraud/reCAPTCHA, tax documentation,
-        # notification emails, and other program settings).
-        #
-        # To see the full object with every field and its current value, `GET` this
-        # resource, then `PATCH` back only the fields you want to change.
+        # 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.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -27,13 +26,12 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's options configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. Unknown fields and invalid values return a
-        # `400`.
-        #
-        # The request body is a partial {CampaignOptions} object. To see the full object
-        # with every field and its current value, `GET` this resource, then `PATCH` back
-        # only the fields you want to change.
+        # 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".
         #
         # @overload update(id, body, request_options: {})
         #