growsurf-ruby 1.4.0 → 1.5.1

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi

@@ -32,6 +32,18 @@ module GrowsurfRuby
       sig { returns(Integer) }
       attr_accessor :start_date
 
+      sig do
+        returns(T.nilable(GrowsurfRuby::Models::CampaignEngagementAnalytics))
+      end
+      attr_reader :engagement
+
+      sig do
+        params(
+          engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics::OrHash
+        ).void
+      end
+      attr_writer :engagement
+
       # Present only when `include` contains `previousPeriod`.
       sig do
         returns(
@@ -115,6 +127,7 @@ module GrowsurfRuby
             GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics::OrHash,
           end_date: Integer,
           start_date: Integer,
+          engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics::OrHash,
           previous_period:
             GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod::OrHash,
           rates:
@@ -131,6 +144,8 @@ module GrowsurfRuby
         analytics:,
         end_date:,
         start_date:,
+        # Present only when `include` contains `engagement`.
+        engagement: nil,
         # Present only when `include` contains `previousPeriod`.
         previous_period: nil,
         # Present only when `include` contains `rates`.
@@ -150,6 +165,7 @@ module GrowsurfRuby
               GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
             end_date: Integer,
             start_date: Integer,
+            engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics,
             previous_period:
               GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
             rates:
@@ -1386,16 +1402,20 @@ module GrowsurfRuby
 
           # Reward counts grouped by review and fulfillment status.
           sig do
-            params(completed: Integer, unapproved: Integer, unfulfilled: Integer).returns(T.attached_class)
+            params(
+              completed: Integer,
+              unapproved: Integer,
+              unfulfilled: Integer
+            ).returns(T.attached_class)
           end
-          def self.new(
-            completed: nil,
-            unapproved: nil,
-            unfulfilled: nil
-          )
+          def self.new(completed: nil, unapproved: nil, unfulfilled: nil)
           end
 
-          sig { override.returns({ completed: Integer, unapproved: Integer, unfulfilled: Integer }) }
+          sig do
+            override.returns(
+              { completed: Integer, unapproved: Integer, unfulfilled: Integer }
+            )
+          end
           def to_hash
           end
         end

data/rbi/growsurf_ruby/models/commission_structure.rbi

@@ -26,7 +26,9 @@ module GrowsurfRuby
       sig { returns(T.nilable(Integer)) }
       attr_accessor :duration_in_months
 
-      # The event that generates a commission. Missing legacy values read as `SALE`.
+      # The event that generates a commission. `CLICK` and `LEAD` require `FIXED` with
+      # a positive `amount`; `amountISO` defaults to the program currency when omitted.
+      # `SALE` supports `FIXED` or `PERCENT`. Missing legacy values read as `SALE`.
       sig do
         returns(
           T.nilable(GrowsurfRuby::CommissionStructure::Event::TaggedSymbol)

data/rbi/growsurf_ruby/models/participant_commission_list.rbi

@@ -99,7 +99,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :approved_at
 
-        sig { params(approved_at: Integer).void }
+        sig { params(approved_at: T.nilable(Integer)).void }
         attr_writer :approved_at
 
         sig { returns(T.nilable(String)) }
@@ -111,7 +111,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :exchange_rate_at
 
-        sig { params(exchange_rate_at: Integer).void }
+        sig { params(exchange_rate_at: T.nilable(Integer)).void }
         attr_writer :exchange_rate_at
 
         sig { returns(T.nilable(String)) }
@@ -123,13 +123,13 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :paid_at
 
-        sig { params(paid_at: Integer).void }
+        sig { params(paid_at: T.nilable(Integer)).void }
         attr_writer :paid_at
 
         sig { returns(T.nilable(Integer)) }
         attr_reader :payout_queued_at
 
-        sig { params(payout_queued_at: Integer).void }
+        sig { params(payout_queued_at: T.nilable(Integer)).void }
         attr_writer :payout_queued_at
 
         sig { returns(T.nilable(String)) }
@@ -138,7 +138,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :reversed_at
 
-        sig { params(reversed_at: Integer).void }
+        sig { params(reversed_at: T.nilable(Integer)).void }
         attr_writer :reversed_at
 
         sig { returns(T.nilable(Integer)) }
@@ -158,16 +158,16 @@ module GrowsurfRuby
             status:
               GrowsurfRuby::ParticipantCommissionList::Commission::Status::OrSymbol,
             amount_in_campaign_currency: T.nilable(Integer),
-            approved_at: Integer,
+            approved_at: T.nilable(Integer),
             campaign_currency_iso: T.nilable(String),
             exchange_rate: T.nilable(Float),
-            exchange_rate_at: Integer,
+            exchange_rate_at: T.nilable(Integer),
             fx_error: T.nilable(String),
             hold_duration: T.nilable(Integer),
-            paid_at: Integer,
-            payout_queued_at: Integer,
+            paid_at: T.nilable(Integer),
+            payout_queued_at: T.nilable(Integer),
             provider: T.nilable(String),
-            reversed_at: Integer,
+            reversed_at: T.nilable(Integer),
             sale_amount_in_campaign_currency: T.nilable(Integer)
           ).returns(T.attached_class)
         end
@@ -212,16 +212,16 @@ module GrowsurfRuby
               status:
                 GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol,
               amount_in_campaign_currency: T.nilable(Integer),
-              approved_at: Integer,
+              approved_at: T.nilable(Integer),
               campaign_currency_iso: T.nilable(String),
               exchange_rate: T.nilable(Float),
-              exchange_rate_at: Integer,
+              exchange_rate_at: T.nilable(Integer),
               fx_error: T.nilable(String),
               hold_duration: T.nilable(Integer),
-              paid_at: Integer,
-              payout_queued_at: Integer,
+              paid_at: T.nilable(Integer),
+              payout_queued_at: T.nilable(Integer),
               provider: T.nilable(String),
-              reversed_at: Integer,
+              reversed_at: T.nilable(Integer),
               sale_amount_in_campaign_currency: T.nilable(Integer)
             }
           )

data/rbi/growsurf_ruby/models/participant_payout_list.rbi

@@ -88,13 +88,13 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :exchange_rate_at
 
-        sig { params(exchange_rate_at: Integer).void }
+        sig { params(exchange_rate_at: T.nilable(Integer)).void }
         attr_writer :exchange_rate_at
 
         sig { returns(T.nilable(Integer)) }
         attr_reader :failed_at
 
-        sig { params(failed_at: Integer).void }
+        sig { params(failed_at: T.nilable(Integer)).void }
         attr_writer :failed_at
 
         sig { returns(T.nilable(String)) }
@@ -103,7 +103,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :issued_at
 
-        sig { params(issued_at: Integer).void }
+        sig { params(issued_at: T.nilable(Integer)).void }
         attr_writer :issued_at
 
         sig { returns(T.nilable(String)) }
@@ -112,13 +112,13 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :queued_at
 
-        sig { params(queued_at: Integer).void }
+        sig { params(queued_at: T.nilable(Integer)).void }
         attr_writer :queued_at
 
         sig { returns(T.nilable(Integer)) }
         attr_reader :reversed_at
 
-        sig { params(reversed_at: Integer).void }
+        sig { params(reversed_at: T.nilable(Integer)).void }
         attr_writer :reversed_at
 
         sig do
@@ -134,13 +134,13 @@ module GrowsurfRuby
             amount_in_campaign_currency: T.nilable(Integer),
             campaign_currency_iso: T.nilable(String),
             exchange_rate: T.nilable(Float),
-            exchange_rate_at: Integer,
-            failed_at: Integer,
+            exchange_rate_at: T.nilable(Integer),
+            failed_at: T.nilable(Integer),
             fx_error: T.nilable(String),
-            issued_at: Integer,
+            issued_at: T.nilable(Integer),
             provider: T.nilable(String),
-            queued_at: Integer,
-            reversed_at: Integer
+            queued_at: T.nilable(Integer),
+            reversed_at: T.nilable(Integer)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -178,13 +178,13 @@ module GrowsurfRuby
               amount_in_campaign_currency: T.nilable(Integer),
               campaign_currency_iso: T.nilable(String),
               exchange_rate: T.nilable(Float),
-              exchange_rate_at: Integer,
-              failed_at: Integer,
+              exchange_rate_at: T.nilable(Integer),
+              failed_at: T.nilable(Integer),
               fx_error: T.nilable(String),
-              issued_at: Integer,
+              issued_at: T.nilable(Integer),
               provider: T.nilable(String),
-              queued_at: Integer,
-              reversed_at: Integer
+              queued_at: T.nilable(Integer),
+              reversed_at: T.nilable(Integer)
             }
           )
         end

data/rbi/growsurf_ruby/models.rbi

@@ -3,6 +3,10 @@
 module GrowsurfRuby
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  AnalyticsAvailability = GrowsurfRuby::Models::AnalyticsAvailability
+
+  AnalyticsUnavailableReason = GrowsurfRuby::Models::AnalyticsUnavailableReason
+
   AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
 
   AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
@@ -51,6 +55,9 @@ module GrowsurfRuby
   CampaignRetrieveAffiliateApplicationParams =
     GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
 
+  CampaignRetrieveActivationAnalyticsParams =
+    GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams
+
   CampaignRetrieveAnalyticsParams =
     GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 

data/rbi/growsurf_ruby/resources/account.rbi

@@ -4,8 +4,13 @@ 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 team owner's email address is
+      # an API key. Before calling it, an authorized account owner must review and
+      # approve GrowSurf's [Terms of Service](https://growsurf.com/terms) and [Privacy
+      # Policy](https://growsurf.com/privacy). The account starts a 14-day Business
+      # trial without a credit card. The response includes an API key for the new
+      # account, shown once in the response. The key is a secret: store it in a secret
+      # manager and do not put it in logs, screenshots, URLs, model context, analytics,
+      # or generated output. 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
@@ -13,10 +18,8 @@ module GrowsurfRuby
       # 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).
+      # additionally require GrowSurf to verify the team first. Calling this endpoint
+      # accepts those policies on the account holder's behalf.
       sig do
         params(
           email: String,

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

@@ -4,10 +4,37 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Design
+        # Icon configuration for the participant Resources destination.
+        ResourcesIcon = T.type_alias do
+          {
+            type: T.nilable(T.any(String, Symbol)),
+            imageUrl: T.nilable(String)
+          }
+        end
+
+        # Participant presentation settings for Resources. Each label is limited to 100
+        # characters; imageUrl is limited to 500. Resource items use Program Resources operations.
+        Resources = T.type_alias do
+          {
+            isPublicDisplayed: T.nilable(T::Boolean),
+            title: T.nilable(String),
+            viewResourcesLinkText: T.nilable(String),
+            backLinkText: T.nilable(String),
+            copyButtonText: T.nilable(String),
+            copiedText: T.nilable(String),
+            emptyState: T.nilable(String),
+            icon: T.nilable(ResourcesIcon)
+          }
+        end
+
         # Retrieves a program's design configuration — the same surface as the dashboard
         # 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. Available fields depend on the program type.
+        # channels + invite, signup form, Resources presentation, portal/landing pages, theme styling, and the
+        # referral/affiliate summary + status sections. `referredExperience` includes the Claim
+        # Offer Popup for both program types, with its colors under
+        # `theme.referredExperienceOfferPopup`.
+        # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
+        # unknown values mean `INITIALS`.
         # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
         # `null` fields are returned as `null`; omitted and `null` fields use localized defaults.
         sig do
@@ -24,7 +51,7 @@ module GrowsurfRuby
         end
 
         # Updates a program's design configuration, including the payout-destination confirmation
-        # page copy configured from payout integration cards. Only the fields you send are
+        # page copy and the Claim Offer Popup under `referredExperience`. 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`. Landing-page custom code and JavaScript are not editable via the
@@ -39,7 +66,8 @@ module GrowsurfRuby
         def update(
           # GrowSurf program ID.
           id,
-          # Partial design configuration to merge.
+          # Partial design configuration to merge. `resources` accepts visibility, title,
+          # list/back/copy labels, and an icon with type `DEFAULT`, `IMAGE`, or `NONE`.
           body,
           request_options: {}
         )

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

@@ -8,7 +8,8 @@ module GrowsurfRuby
         # 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).
+        # type (referral vs affiliate). `offerClaimed` is available to both program types and sends
+        # while the Claim Offer Popup is enabled.
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/integrations.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Integrations
+        # Lists every integration this program can connect, each with its current state.
+        # Integrations that do not apply to the program type are omitted (for example,
+        # Wise on a referral program). Read-only: connecting an integration is an OAuth or
+        # credential handshake completed in the GrowSurf dashboard, so it cannot be done
+        # over the API. `connected` means credentials are stored, `enabled` means the
+        # integration is switched on and working, and `autoDisabled` means GrowSurf
+        # switched it off after repeated delivery failures — its credentials are still
+        # stored, but it delivers nothing until it is reconnected in the dashboard.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::IntegrationListResponse)
+        end
+        def list(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
         end
         def retrieve(
-          # GrowSurf participant ID or URL-encoded participant email address.
+          # GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # GrowSurf program ID.
           id:,
@@ -46,7 +46,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
         end
         def update(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -86,7 +86,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::Models::Campaign::ParticipantDeleteResponse)
         end
         def delete(
-          # GrowSurf participant ID or URL-encoded participant email address.
+          # GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # GrowSurf program ID.
           id:,
@@ -189,7 +189,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::ParticipantCommissionList)
         end
         def list_commissions(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -217,7 +217,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::ParticipantPayoutList)
         end
         def list_payouts(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -250,7 +250,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::ReferralList)
         end
         def list_referrals(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -289,7 +289,7 @@ module GrowsurfRuby
           )
         end
         def list_rewards(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -334,13 +334,15 @@ module GrowsurfRuby
             total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
             total_taxes: T::Array[T::Hash[Symbol, T.anything]],
             transaction_id: String,
+            payment_provider: String,
+            test_mode: T::Boolean,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(
             GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::Variants
           )
         end
         def record_transaction(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -390,6 +392,8 @@ module GrowsurfRuby
           total_taxes: nil,
           # Body param
           transaction_id: nil,
+          payment_provider: nil,
+          test_mode: nil,
           request_options: {}
         )
         end
@@ -399,7 +403,8 @@ module GrowsurfRuby
         # 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.
+        # affiliate are not clawed back. The amendment still updates the sale revenue used
+        # in program reporting; full refunds and chargebacks also update tax reporting.
         sig do
           params(
             participant_id_or_email: String,
@@ -420,13 +425,15 @@ module GrowsurfRuby
             refund_id: String,
             refund_status: String,
             transaction_id: String,
+            payment_provider: String,
+            test_mode: T::Boolean,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(
             GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
           )
         end
         def refund_transaction(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -460,6 +467,8 @@ module GrowsurfRuby
           refund_status: nil,
           # Body param
           transaction_id: nil,
+          payment_provider: nil,
+          test_mode: nil,
           request_options: {}
         )
         end
@@ -480,7 +489,7 @@ module GrowsurfRuby
           )
         end
         def send_invites(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -510,7 +519,7 @@ module GrowsurfRuby
           )
         end
         def trigger_referral(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -539,7 +548,7 @@ module GrowsurfRuby
           )
         end
         def cancel_delayed_referral(
-          # GrowSurf participant ID or URL-encoded participant email address.
+          # GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # GrowSurf program ID.
           id:,
@@ -567,7 +576,7 @@ module GrowsurfRuby
           ).returns(GrowsurfRuby::Models::Campaign::ParticipantEmailResponse)
         end
         def email(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -609,7 +618,7 @@ module GrowsurfRuby
           )
         end
         def list_activity_logs(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
@@ -645,7 +654,7 @@ module GrowsurfRuby
           )
         end
         def retrieve_analytics(
-          # GrowSurf participant ID or URL-encoded participant email address.
+          # GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # GrowSurf program ID.
           id:,
@@ -690,7 +699,7 @@ module GrowsurfRuby
           )
         end
         def get_payout_destination(
-          # GrowSurf participant ID or URL-encoded participant email address.
+          # GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # GrowSurf program ID.
           id:,
@@ -714,7 +723,7 @@ module GrowsurfRuby
           )
         end
         def request_payout_destination_confirmation(
-          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          # Path param: GrowSurf participant ID or unencoded participant email address (the SDK encodes it automatically).
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,