growsurf-ruby 1.1.2 → 1.2.1

data/rbi/growsurf_ruby/models/{account_rotate_api_key_response.rbi → team_rotate_api_key_response.rbi}

@@ -2,24 +2,20 @@
 
 module GrowsurfRuby
   module Models
-    class AccountRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
+    class TeamRotateAPIKeyResponse < GrowsurfRuby::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            GrowsurfRuby::Models::AccountRotateAPIKeyResponse,
+            GrowsurfRuby::Models::TeamRotateAPIKeyResponse,
             GrowsurfRuby::Internal::AnyHash
           )
         end
 
-      # The new API key. Store it now; the key used for rotation stops working immediately.
       sig { returns(String) }
       attr_accessor :api_key
 
       sig { params(api_key: String).returns(T.attached_class) }
-      def self.new(
-        # The new API key. Store it now; the key used for rotation stops working immediately.
-        api_key:
-      )
+      def self.new(api_key:)
       end
 
       sig { override.returns({ api_key: String }) }

data/rbi/growsurf_ruby/models/team_update_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class TeamUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(GrowsurfRuby::TeamUpdateParams, GrowsurfRuby::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(
+          name: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(name:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { name: String, request_options: GrowsurfRuby::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -1,11 +1,11 @@
 # typed: strong
 
 module GrowsurfRuby
-  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/rbi/growsurf_ruby/resources/account.rbi

@@ -4,20 +4,19 @@ 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).
       sig do
         params(
           email: String,
@@ -28,7 +27,6 @@ module GrowsurfRuby
         ).returns(GrowsurfRuby::Models::AccountCreateResponse)
       end
       def create(
-        # The email address for the new account. Personal emails and disposable email addresses are not accepted.
         email:,
         company: nil,
         first_name: nil,
@@ -37,76 +35,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.
-      sig do
-        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
-          GrowsurfRuby::Account
-        )
-      end
-      def retrieve(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.
-      sig do
-        params(
-          company: String,
-          first_name: String,
-          last_name: String,
-          request_options: GrowsurfRuby::RequestOptions::OrHash
-        ).returns(GrowsurfRuby::Account)
-      end
-      def update(
-        company: nil,
-        first_name: nil,
-        last_name: nil,
-        request_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.
-      sig do
-        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
-          GrowsurfRuby::Models::AccountRotateAPIKeyResponse
-        )
-      end
-      def rotate_api_key(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`.
-      sig do
-        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
-          GrowsurfRuby::Account
-        )
-      end
-      def request_verification(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.
-      sig do
-        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
-          GrowsurfRuby::Models::AccountResendVerificationEmailResponse
-        )
-      end
-      def resend_verification_email(request_options: {})
-      end
-
-      # @api private
       sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
       def self.new(client:)
       end

data/rbi/growsurf_ruby/resources/campaign/commission.rbi

@@ -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.
         sig do
           params(
             commission_id: String,
@@ -22,7 +22,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.
         sig do
           params(
             commission_id: String,

data/rbi/growsurf_ruby/resources/campaign/design.rbi

@@ -5,9 +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. This is a large, deeply nested object whose
+        # 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 update.
+        # and its current value, which is the same shape you send back on `PATCH`.
         sig do
           params(
             id: String,
@@ -23,9 +25,9 @@ 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). The request body is a partial design 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.
+        # wholesale). Unknown fields, fields not available for the program type, and
+        # invalid values return a `400`. Landing-page custom code and JavaScript are not
+        # editable via the API.
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/emails.rbi

@@ -5,9 +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. 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).
         sig do
           params(
             id: String,
@@ -22,9 +23,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's email configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. The request body is a partial email
-        # configuration 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).
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/installation.rbi

@@ -5,10 +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. 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.
         sig do
           params(
             id: String,
@@ -23,10 +22,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's installation configuration. Only the fields you send are
-        # changed; anything you leave out is untouched. The request body is a partial
-        # installation configuration 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.
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/options.rbi

@@ -4,10 +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. 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.
         sig do
           params(
             id: String,
@@ -21,10 +22,12 @@ module GrowsurfRuby
         )
         end
 
-        # Updates a program's options configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. The request body is a partial options
-        # configuration 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".
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -88,12 +88,12 @@ module GrowsurfRuby
         end
 
         # Deletes a list of participants from a program in one request. Each entry in
-        # `participants` is a GrowSurf participant ID or an email address (mixed lists
-        # are allowed). Up to `200` entries per request — chunk larger lists across
-        # multiple calls. The response reports a per-row `status` for every submitted
-        # entry, so a `200` can include rows that were `NOT_FOUND` or failed. Deletion
-        # is permanent and removes the participants' referrals, rewards, commissions,
-        # and payout records.
+        # `participants` is a GrowSurf participant ID or an email address (mixed lists are
+        # allowed). Up to `200` entries per request — chunk larger lists across multiple
+        # calls. The response reports a per-row `status` for every submitted entry, so a
+        # `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent
+        # and removes the participants' referrals, rewards, commissions, and payout
+        # records.
         sig do
           params(
             id: String,
@@ -156,7 +156,8 @@ module GrowsurfRuby
         )
         end
 
-        # Retrieves a paged list of commissions earned by a participant.
+        # **Affiliate programs only.** Retrieves a paged list of commissions earned by a
+        # participant.
         sig do
           params(
             participant_id_or_email: String,
@@ -183,7 +184,8 @@ module GrowsurfRuby
         )
         end
 
-        # Retrieves a paged list of payouts that belong to a participant.
+        # **Affiliate programs only.** Retrieves a paged list of payouts that belong to a
+        # participant.
         sig do
           params(
             participant_id_or_email: String,
@@ -280,15 +282,12 @@ module GrowsurfRuby
         )
         end
 
-        # Records a sale made by a referred customer and generates affiliate commissions
-        # for their referrer when applicable.
-        #
-        # At least one transaction identifier is required: one of +external_id+,
-        # +transaction_id+, +order_id+, +payment_id+, +invoice_id+, +payment_intent_id+,
-        # or +charge_id+. +customer_id+ and +subscription_id+ do not count, since they
-        # identify the customer or subscription rather than the specific transaction.
-        # Without an identifier, resending the same sale creates a duplicate commission
-        # and double-pays the referrer; the server rejects such requests with HTTP 400.
+        # **Affiliate programs only.** Records a sale made by a referred customer and
+        # generates affiliate commissions for their referrer when applicable. Requires at
+        # least one transaction identifier (externalId, transactionId, orderId, paymentId,
+        # invoiceId, paymentIntentId, or chargeId) so repeated requests can be
+        # de-duplicated — without one, a resent sale would create a second commission.
+        # Reuse the same identifier(s) when refunding.
         sig do
           params(
             participant_id_or_email: String,
@@ -376,9 +375,12 @@ module GrowsurfRuby
         )
         end
 
-        # Records an amendment (refund, partial refund, refund cancellation, or
-        # chargeback) against a previously recorded transaction and reverses or adjusts
-        # the referrer's commission.
+        # **Affiliate programs only.** Records an amendment (refund, partial refund,
+        # refund cancellation, or chargeback) against a previously recorded transaction
+        # and reverses or adjusts the referrer's commission. The inverse of Record
+        # Affiliate Transaction. Identify the original transaction with the same
+        # identifier(s) you sent when recording it. Commissions already paid out to the
+        # affiliate are not clawed back; the amendment is recorded for tax reporting only.
         sig do
           params(
             participant_id_or_email: String,
@@ -444,7 +446,7 @@ module GrowsurfRuby
         end
 
         # Sends email invites on behalf of a participant to a list of email addresses.
-        # Sending invites via the API requires a verified custom email domain on the
+        # Sending invites via the API requires a **verified custom email domain** on the
         # program; the request fails until one is verified.
         sig do
           params(
@@ -474,7 +476,10 @@ module GrowsurfRuby
         end
 
         # Triggers referral credit for an existing referred participant by GrowSurf
-        # participant ID or email address.
+        # participant ID or email address. Optionally pass `delayInDays` to hold the
+        # credit for a number of days before it is awarded (for example, to cover your own
+        # refund window). A delayed trigger can be cancelled before it is awarded with the
+        # Cancel delayed referral trigger request (DELETE on this same path).
         sig do
           params(
             participant_id_or_email: String,
@@ -500,8 +505,11 @@ module GrowsurfRuby
         )
         end
 
-        # Cancels a pending delayed referral trigger for an existing referred participant
-        # by GrowSurf participant ID or email address.
+        # Cancels a pending delayed referral trigger for a participant (the companion to a
+        # delayed Trigger referral request). Use this to undo a scheduled referral credit
+        # before it is awarded, for example when a refund occurs inside your refund
+        # window. If the participant has no pending delayed trigger, `success` is returned
+        # as `false`.
         sig do
           params(
             participant_id_or_email: String,
@@ -520,15 +528,14 @@ module GrowsurfRuby
         )
         end
 
-        # Sends an email to a participant. Provide EITHER `email_type` to trigger one of the
-        # program's configured email templates, OR `subject` + `body` for a free-form email.
-        # Free-form emails are sent with the same compliance handling (company name,
-        # postal address, and an unsubscribe link are added automatically, and unsubscribed
-        # participants are suppressed). Sending requires the account to be verified by the
-        # GrowSurf team. Requires a verified custom email domain on the program (set up
-        # in Campaign Editor > 3. Emails > Email Settings). Returns `400` until one is
-        # verified.
-        # The email is accepted for delivery.
+        # Sends an email to a participant. Provide EITHER `emailType` to trigger one of
+        # the program's configured email templates, OR `subject` + `body` for a free-form
+        # email. Free-form emails are sent with the same compliance handling (company
+        # 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*).
+        # Returns `400` until one is verified. The email is accepted for delivery.
         sig do
           params(
             participant_id_or_email: String,
@@ -569,7 +576,8 @@ module GrowsurfRuby
         )
         end
 
-        # Returns a participant's activity logs, most recent first (offset/limit paginated).
+        # Returns a participant's activity logs, most recent first (offset/limit
+        # paginated).
         sig do
           params(
             participant_id_or_email: String,
@@ -595,8 +603,9 @@ module GrowsurfRuby
         end
 
         # Retrieves analytics for a single participant — all-time engagement counters,
-        # leaderboard ranks, and per-channel share counts (plus affiliate money metrics for
-        # affiliate programs). Useful for segmenting and re-engaging participants.
+        # leaderboard ranks, and per-channel share counts (plus affiliate money metrics
+        # for affiliate programs). Useful for segmenting and re-engaging participants.
+        # Pass `include=series` to also get this participant's own activity over time.
         sig do
           params(
             participant_id_or_email: String,

data/rbi/growsurf_ruby/resources/campaign/reward.rbi

@@ -23,8 +23,9 @@ module GrowsurfRuby
         )
         end
 
-        # Approves a manually approved reward earned by a participant. Requires
-        # `reward:write`. Passing `fulfill: true` also requires `reward:fulfill`.
+        # Approves a manually approved reward earned by a participant. This requires
+        # `reward:write`. When the request also sets `fulfill` to `true`, it additionally
+        # requires `reward:fulfill`.
         sig do
           params(
             reward_id: String,
@@ -44,7 +45,7 @@ module GrowsurfRuby
         )
         end
 
-        # Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
+        # Marks an approved participant reward as fulfilled.
         sig do
           params(
             reward_id: String,

data/rbi/growsurf_ruby/resources/campaign/rewards.rbi

@@ -4,7 +4,9 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # Retrieves the rewards configured for a program.
+        # Retrieves the list of a program's configured rewards (`CampaignReward`s) — the
+        # same set embedded in the `rewards` array of the campaign response. Delete a
+        # reward with `DELETE /campaign/{id}/reward-configs/{campaignRewardId}`.
         sig do
           params(
             id: String,
@@ -18,8 +20,11 @@ module GrowsurfRuby
         )
         end
 
-        # Creates a reward for a program. The reward `type` must be compatible with the
-        # program type.
+        # Creates a new campaign reward (`CampaignReward`) with a GrowSurf-assigned ID.
+        # The reward type must be compatible with the program type (affiliate programs
+        # support only `AFFILIATE` rewards; referral programs support all other types).
+        # Enabling an active reward of a type automatically enables that reward type on
+        # the program.
         sig do
           params(
             id: String,
@@ -112,8 +117,11 @@ module GrowsurfRuby
         )
         end
 
-        # Updates an existing campaign reward. Only the fields you send are changed; `type`
-        # is immutable and must not be supplied.
+        # Updates an existing campaign reward (`CampaignReward`). The reward `type` is
+        # immutable and cannot be changed. When the update replaces `metadata`, renamed
+        # keys automatically rewrite any `{{campaignReward[…]}}` references in campaign
+        # copy; removing a key that campaign copy still references returns a `409` listing
+        # the referencing fields.
         sig do
           params(
             campaign_reward_id: String,
@@ -205,7 +213,11 @@ module GrowsurfRuby
         )
         end
 
-        # Deletes a campaign reward.
+        # Deletes a campaign reward (`CampaignReward`). The reward is deactivated, removed
+        # from the program's reward set, and any connected upfront-discount coupons are
+        # cleaned up. If campaign copy still references any of the reward's metadata keys
+        # via `{{campaignReward[…]}}` tokens, the delete returns a `409` listing the
+        # referencing fields — update those fields first.
         sig do
           params(
             campaign_reward_id: String,

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -61,9 +61,8 @@ module GrowsurfRuby
       def list(request_options: {})
       end
 
-      # Creates a program. Only `type` is required; everything else is server-defaulted.
-      # Editor-tab configuration (design, emails, options, installation) is not accepted
-      # here — configure it via the config sub-resources after the program is created.
+      # 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.
       sig do
         params(
           type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
@@ -91,10 +90,11 @@ module GrowsurfRuby
       )
       end
 
-      # 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.
+      # 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.
       sig do
         params(
           id: String,
@@ -121,7 +121,8 @@ module GrowsurfRuby
       )
       end
 
-      # Clones an existing program, returning the newly created program.
+      # Clones an existing program into a new `DRAFT` program. Integrations and
+      # credentials are not copied; active rewards are cloned.
       sig do
         params(
           id: String,
@@ -178,7 +179,8 @@ module GrowsurfRuby
       )
       end
 
-      # 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.
       sig do
         params(
           id: String,
@@ -248,7 +250,8 @@ module GrowsurfRuby
       )
       end
 
-      # 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.
       sig do
         params(
           id: String,
@@ -312,7 +315,9 @@ module GrowsurfRuby
       )
       end
 
-      # Retrieves analytics for a program.
+      # 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.
       sig do
         params(
           id: String,