growsurf-ruby 1.8.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc9cb8240076dada54cb5c6791f162c599eb3963e13e2baec3d2f7e2afcf66e
-  data.tar.gz: a631c70f08428385f1bb0afaf6c218b88354804e1a6908ad95a081d87745100d
+  metadata.gz: 639861d0b1e6d0a9d32dad41ddc207c776a71eaa84b5f8455c549bd4f0962ea2
+  data.tar.gz: 8f050dc64bc242a26af0eaf48b04fd8e3986a830d07e65ca7f06b4b072a83007
 SHA512:
-  metadata.gz: 1d5b8aa05bdd8fdf3fbf6822a696c5d76a041e29af11d7e5b7b469067d80c25074bb6324e4fc6f2e756f479917fac70f4dcd6b032a92891734bfaca5f0ba951b
-  data.tar.gz: ce692094a359a416f1441881afbd73880fa1a73abf7f74c722e6832f02c210c211d3658a4c5d6bec94ad60df3d98a7c295060229277069c15900b7086c8bc87f
+  metadata.gz: 5f9ca0a45ec5c4ffd1093e73936986fad8eb7dad5088bc99e1030f3d80a04780cd62f16e0cdf58f1594a8a490d62d87ba4db3d9c14157a083a9a8a62394ab8a4
+  data.tar.gz: 349179a199d646fa5de5626a06f2c0cf11b45ca6e5510191816ecd817c2305ee38e0a68eac3aa8e7aaad7f3d368d34995e4f3441c28151a844703c27e3f02484

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [1.10.0](https://github.com/growsurf/growsurf-ruby/compare/v1.9.0...v1.10.0) (2026-09-23)
+
+
+### Features
+
+* **api:** update SDK campaign contracts and request handling ([86574eb](https://github.com/growsurf/growsurf-ruby/commit/86574ebcadd9997ea10e202cb6e2abe5a58e9f39))
+
+## [1.9.0](https://github.com/growsurf/growsurf-ruby/compare/v1.8.1...v1.9.0) (2026-09-21)
+
+
+### Features
+
+* **api:** add referral-flow screenshot capture and participant leadCount ([5063d8e](https://github.com/growsurf/growsurf-ruby/commit/5063d8ec000bcab673eb783af42dd670cc0d475c))
+
+
+### Chores
+
+* merge origin/main ([10f605f](https://github.com/growsurf/growsurf-ruby/commit/10f605fee31fc665e2fc17a1f930231d840d34be))
+
 ## [1.8.1](https://github.com/growsurf/growsurf-ruby/compare/v1.8.0...v1.8.1) (2026-09-19)
 
 

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.8.1"
+gem "growsurf-ruby", "~> 1.10.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/models/campaign/participant.rb

@@ -135,6 +135,13 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :last_name, String, api_name: :lastName, nil?: true
 
+        # @!attribute lead_count
+        #   The number of pending referrals the participant made that have not converted
+        #   into successful referrals yet.
+        #
+        #   @return [Integer, nil]
+        optional :lead_count, Integer, api_name: :leadCount
+
         # @!attribute metadata
         #   Shallow custom metadata object.
         #
@@ -249,7 +256,7 @@ module GrowsurfRuby
         #   @return [Array<String>, nil]
         optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
 
-        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url: nil, affiliate_enrollment_source: nil, affiliate_status: nil, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_affiliate: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, payout_settings: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
+        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url: nil, affiliate_enrollment_source: nil, affiliate_status: nil, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_affiliate: nil, is_new: nil, is_winner: nil, last_name: nil, lead_count: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, payout_settings: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
         #   Some parameter documentations has been truncated, see
         #   {GrowsurfRuby::Models::Campaign::CampaignParticipant} for more details.
         #
@@ -300,6 +307,8 @@ module GrowsurfRuby
         #
         #   @param last_name [String, nil]
         #
+        #   @param lead_count [Integer] The number of pending referrals the participant made that have not converted
+        #
         #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
         #   @param mobile_instance_id [String, nil] App-install scoped mobile identifier used for anti-fraud matching when provided
@@ -436,6 +445,13 @@ module GrowsurfRuby
           #   @return [String, nil]
           optional :last_name, String, api_name: :lastName, nil?: true
 
+          # @!attribute lead_count
+          #   The number of pending referrals the participant made that have not converted
+          #   into successful referrals yet.
+          #
+          #   @return [Integer, nil]
+          optional :lead_count, Integer, api_name: :leadCount
+
           # @!attribute metadata
           #   Shallow custom metadata object.
           #
@@ -522,7 +538,7 @@ module GrowsurfRuby
           #   @return [Boolean, nil]
           optional :unsubscribed, GrowsurfRuby::Internal::Type::Boolean
 
-          # @!method initialize(id: nil, created_at: nil, email: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_winner: nil, last_name: nil, metadata: nil, monthly_rank: nil, monthly_referral_count: nil, monthly_referrals: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, rank: nil, referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, share_count: nil, share_url: nil, unique_impression_count: nil, unsubscribed: nil)
+          # @!method initialize(id: nil, created_at: nil, email: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_winner: nil, last_name: nil, lead_count: nil, metadata: nil, monthly_rank: nil, monthly_referral_count: nil, monthly_referrals: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, rank: nil, referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, share_count: nil, share_url: nil, unique_impression_count: nil, unsubscribed: nil)
           #   @param id [String]
           #
           #   @param created_at [Integer]
@@ -547,6 +563,8 @@ module GrowsurfRuby
           #
           #   @param last_name [String, nil]
           #
+          #   @param lead_count [Integer] The number of pending referrals the participant made that have not converted
+          #
           #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
           #
           #   @param monthly_rank [Integer]

data/lib/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#capture_referral_flow_screenshots
+    class CampaignCaptureReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute expires_at
+      #   When every screenshot URL in this response stops working. Capture again after
+      #   this time for a fresh view.
+      #
+      #   @return [Time]
+      required :expires_at, Time, api_name: :expiresAt
+
+      # @!attribute generated_at
+      #   When these screenshots were rendered.
+      #
+      #   @return [Time]
+      required :generated_at, Time, api_name: :generatedAt
+
+      # @!attribute screenshots
+      #   One preview image per view: the referrer window a participant sees, and the
+      #   referred-friend experience.
+      #
+      #   @return [Array<GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot>]
+      required :screenshots,
+               -> {
+                 GrowsurfRuby::Internal::Type::ArrayOf[
+                   GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot
+                 ]
+               }
+
+      # @!method initialize(expires_at:, generated_at:, screenshots:)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse} for more
+      #   details.
+      #
+      #   @param expires_at [Time] When every screenshot URL in this response stops working. Capture again after th
+      #
+      #   @param generated_at [Time] When these screenshots were rendered.
+      #
+      #   @param screenshots [Array<GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot>] One preview image per view: the referrer window a participant sees, and the refe
+
+      class Screenshot < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute content_type
+        #   Media type of the image, such as `image/png`.
+        #
+        #   @return [String]
+        required :content_type, String, api_name: :contentType
+
+        # @!attribute expires_at
+        #   When this screenshot URL stops working.
+        #
+        #   @return [Time]
+        required :expires_at, Time, api_name: :expiresAt
+
+        # @!attribute height
+        #   Image height in pixels.
+        #
+        #   @return [Integer]
+        required :height, Integer
+
+        # @!attribute label
+        #   Human-readable name for the view, suitable for a caption.
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!attribute url
+        #   Private URL of the image. It expires at `expiresAt`; do not store it.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute view
+        #   Which part of the referral flow the image shows. `referrer` is the window a
+        #   participant sees; `referredFriend` is the experience their referred friend sees.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View]
+        required :view, enum: -> { GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View }
+
+        # @!attribute width
+        #   Image width in pixels.
+        #
+        #   @return [Integer]
+        required :width, Integer
+
+        # @!method initialize(content_type:, expires_at:, height:, label:, url:, view:, width:)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot}
+        #   for more details.
+        #
+        #   @param content_type [String] Media type of the image, such as `image/png`.
+        #
+        #   @param expires_at [Time] When this screenshot URL stops working.
+        #
+        #   @param height [Integer] Image height in pixels.
+        #
+        #   @param label [String] Human-readable name for the view, suitable for a caption.
+        #
+        #   @param url [String] Private URL of the image. It expires at `expiresAt`; do not store it.
+        #
+        #   @param view [Symbol, GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View] Which part of the referral flow the image shows. `referrer` is the window a parti
+        #
+        #   @param width [Integer] Image width in pixels.
+
+        # Which part of the referral flow the image shows. `referrer` is the window a
+        # participant sees; `referredFriend` is the experience their referred friend sees.
+        #
+        # @see GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot#view
+        module View
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFERRER = :referrer
+          REFERRED_FRIEND = :referredFriend
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module GrowsurfRuby
         # types, with its colors under `theme.referredExperienceOfferPopup`. `widget` is the website
         # widget shown in a corner of your own site, with its colors under `theme.widget`;
         # both of its audience switches start off, so a program shows nothing until you turn one
-        # on.
+        # on. `trafficInsights` is the participant Traffic report; it starts on for new affiliate
+        # programs and hidden for referral programs, and `GET` returns every setting with its
+        # default copy.
         # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
         # unknown values mean `INITIALS`.
         # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
@@ -35,8 +37,9 @@ module GrowsurfRuby
         end
 
         # Updates a program's design configuration, including the payout-destination confirmation
-        # page copy, the Claim Offer Popup under `referredExperience`, and the website widget under
-        # `widget`. Only the fields you send
+        # page copy, the Claim Offer Popup under `referredExperience`, the website widget under
+        # `widget`, and the participant Traffic report under `trafficInsights` (its labels cannot be
+        # blank). 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

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

@@ -4,9 +4,9 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # 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}`.
+        # Retrieves configured Campaign Rewards, including switched-off rewards and rewards
+        # whose group is not selected. Deleted rewards are excluded. The campaign response's
+        # embedded rewards array includes only enabled, visible rewards.
         #
         # @overload list(id, request_options: {})
         #

data/lib/growsurf_ruby/resources/campaign.rb

@@ -172,6 +172,30 @@ module GrowsurfRuby
         )
       end
 
+      # Renders the program's current saved configuration into two preview images: the
+      # referrer window a participant sees, and the referred-friend experience. Use them
+      # to show a person what the draft looks like before anything launches. The images
+      # render GrowSurf's own preview, not the program's installed website, so they do
+      # not prove an installation. Each URL is private and expires; capture again when
+      # you need a fresh view. Only the account owner's credential can capture
+      # screenshots, and the endpoint takes no request body.
+      #
+      # @overload capture_referral_flow_screenshots(id, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse]
+      def capture_referral_flow_screenshots(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaign/%1$s/referral-flow-screenshots", id],
+          model: GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Invites someone to join the affiliate program. GrowSurf emails them a single-use
       # accept link; accepting it enrolls them as an approved affiliate without going
       # through the public application. One active invite can exist per email address.

data/lib/growsurf_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrowsurfRuby
-  VERSION = "1.8.1"
+  VERSION = "1.10.0"
 end

data/lib/growsurf_ruby.rb

@@ -143,6 +143,7 @@ require_relative "growsurf_ruby/models/team_resend_owner_verification_email_resp
 require_relative "growsurf_ruby/models/team_rotate_api_key_response"
 require_relative "growsurf_ruby/models/team_update_params"
 require_relative "growsurf_ruby/models/campaign"
+require_relative "growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response"
 require_relative "growsurf_ruby/models/campaign_create_affiliate_invite_params"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_params"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_response"

data/rbi/growsurf_ruby/models/campaign/participant.rbi

@@ -132,6 +132,14 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :last_name
 
+        # The number of pending referrals the participant made that have not converted
+        # into successful referrals yet.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :lead_count
+
+        sig { params(lead_count: Integer).void }
+        attr_writer :lead_count
+
         # Shallow custom metadata object.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :metadata
@@ -311,6 +319,7 @@ module GrowsurfRuby
             is_new: T::Boolean,
             is_winner: T::Boolean,
             last_name: T.nilable(String),
+            lead_count: Integer,
             metadata: T::Hash[Symbol, T.anything],
             mobile_instance_id: T.nilable(String),
             monthly_referrals: T::Array[String],
@@ -369,6 +378,9 @@ module GrowsurfRuby
           is_new: nil,
           is_winner: nil,
           last_name: nil,
+          # The number of pending referrals the participant made that have not converted
+          # into successful referrals yet.
+          lead_count: nil,
           # Shallow custom metadata object.
           metadata: nil,
           # App-install scoped mobile identifier used for anti-fraud matching when provided
@@ -425,6 +437,7 @@ module GrowsurfRuby
               is_new: T::Boolean,
               is_winner: T::Boolean,
               last_name: T.nilable(String),
+              lead_count: Integer,
               metadata: T::Hash[Symbol, T.anything],
               mobile_instance_id: T.nilable(String),
               monthly_referrals: T::Array[String],
@@ -629,6 +642,14 @@ module GrowsurfRuby
           sig { returns(T.nilable(String)) }
           attr_accessor :last_name
 
+          # The number of pending referrals the participant made that have not converted
+          # into successful referrals yet.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :lead_count
+
+          sig { params(lead_count: Integer).void }
+          attr_writer :lead_count
+
           # Shallow custom metadata object.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :metadata
@@ -751,6 +772,7 @@ module GrowsurfRuby
               ip_address: T.nilable(String),
               is_winner: T::Boolean,
               last_name: T.nilable(String),
+              lead_count: Integer,
               metadata: T::Hash[Symbol, T.anything],
               monthly_rank: Integer,
               monthly_referral_count: Integer,
@@ -781,6 +803,9 @@ module GrowsurfRuby
             ip_address: nil,
             is_winner: nil,
             last_name: nil,
+            # The number of pending referrals the participant made that have not converted
+            # into successful referrals yet.
+            lead_count: nil,
             # Shallow custom metadata object.
             metadata: nil,
             monthly_rank: nil,
@@ -816,6 +841,7 @@ module GrowsurfRuby
                 ip_address: T.nilable(String),
                 is_winner: T::Boolean,
                 last_name: T.nilable(String),
+                lead_count: Integer,
                 metadata: T::Hash[Symbol, T.anything],
                 monthly_rank: Integer,
                 monthly_referral_count: Integer,

data/rbi/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignCaptureReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # When every screenshot URL in this response stops working. Capture again after
+      # this time for a fresh view.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # When these screenshots were rendered.
+      sig { returns(Time) }
+      attr_accessor :generated_at
+
+      # One preview image per view: the referrer window a participant sees, and the
+      # referred-friend experience.
+      sig do
+        returns(
+          T::Array[
+            GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot
+          ]
+        )
+      end
+      attr_accessor :screenshots
+
+      sig do
+        params(
+          expires_at: Time,
+          generated_at: Time,
+          screenshots:
+            T::Array[
+              GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # When every screenshot URL in this response stops working. Capture again after
+        # this time for a fresh view.
+        expires_at:,
+        # When these screenshots were rendered.
+        generated_at:,
+        # One preview image per view: the referrer window a participant sees, and the
+        # referred-friend experience.
+        screenshots:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            expires_at: Time,
+            generated_at: Time,
+            screenshots:
+              T::Array[
+                GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Screenshot < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # Media type of the image, such as `image/png`.
+        sig { returns(String) }
+        attr_accessor :content_type
+
+        # When this screenshot URL stops working.
+        sig { returns(Time) }
+        attr_accessor :expires_at
+
+        # Image height in pixels.
+        sig { returns(Integer) }
+        attr_accessor :height
+
+        # Human-readable name for the view, suitable for a caption.
+        sig { returns(String) }
+        attr_accessor :label
+
+        # Private URL of the image. It expires at `expiresAt`; do not store it.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Which part of the referral flow the image shows. `referrer` is the window a
+        # participant sees; `referredFriend` is the experience their referred friend sees.
+        sig do
+          returns(
+            GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::TaggedSymbol
+          )
+        end
+        attr_accessor :view
+
+        # Image width in pixels.
+        sig { returns(Integer) }
+        attr_accessor :width
+
+        sig do
+          params(
+            content_type: String,
+            expires_at: Time,
+            height: Integer,
+            label: String,
+            url: String,
+            view:
+              GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::OrSymbol,
+            width: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Media type of the image, such as `image/png`.
+          content_type:,
+          # When this screenshot URL stops working.
+          expires_at:,
+          # Image height in pixels.
+          height:,
+          # Human-readable name for the view, suitable for a caption.
+          label:,
+          # Private URL of the image. It expires at `expiresAt`; do not store it.
+          url:,
+          # Which part of the referral flow the image shows. `referrer` is the window a
+          # participant sees; `referredFriend` is the experience their referred friend sees.
+          view:,
+          # Image width in pixels.
+          width:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_type: String,
+              expires_at: Time,
+              height: Integer,
+              label: String,
+              url: String,
+              view:
+                GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::TaggedSymbol,
+              width: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Which part of the referral flow the image shows. `referrer` is the window a
+        # participant sees; `referredFriend` is the experience their referred friend sees.
+        module View
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REFERRER =
+            T.let(
+              :referrer,
+              GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::TaggedSymbol
+            )
+          REFERRED_FRIEND =
+            T.let(
+              :referredFriend,
+              GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::View::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -35,6 +35,9 @@ module GrowsurfRuby
         # `theme.referredExperienceOfferPopup`. `widget` is the website widget shown in a
         # corner of your own site, with its colors under `theme.widget`; both of its audience
         # switches start off, so a program shows nothing until you turn one on.
+        # `trafficInsights` is the participant Traffic report; it starts on for new affiliate
+        # programs and hidden for referral programs, and `GET` returns every setting with its
+        # default copy.
         # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
         # unknown values mean `INITIALS`.
         # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
@@ -53,8 +56,9 @@ module GrowsurfRuby
         end
 
         # Updates a program's design configuration, including the payout-destination confirmation
-        # page copy, the Claim Offer Popup under `referredExperience`, and the website widget under
-        # `widget`. Only the fields you send are
+        # page copy, the Claim Offer Popup under `referredExperience`, the website widget under
+        # `widget`, and the participant Traffic report under `trafficInsights` (its labels cannot be
+        # blank). 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

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

@@ -4,9 +4,9 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # 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}`.
+        # Retrieves configured Campaign Rewards, including switched-off rewards and rewards
+        # whose group is not selected. Deleted rewards are excluded. The campaign response's
+        # embedded rewards array includes only enabled, visible rewards.
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -151,6 +151,28 @@ module GrowsurfRuby
       )
       end
 
+      # Renders the program's current saved configuration into two preview images: the
+      # referrer window a participant sees, and the referred-friend experience. Use them
+      # to show a person what the draft looks like before anything launches. The images
+      # render GrowSurf's own preview, not the program's installed website, so they do
+      # not prove an installation. Each URL is private and expires; capture again when
+      # you need a fresh view. Only the account owner's credential can capture
+      # screenshots, and the endpoint takes no request body.
+      sig do
+        params(
+          id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(
+          GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse
+        )
+      end
+      def capture_referral_flow_screenshots(
+        # GrowSurf program ID.
+        id,
+        request_options: {}
+      )
+      end
+
       # Invites someone to join the affiliate program. GrowSurf emails them a single-use
       # accept link; accepting it enrolls them as an approved affiliate without going
       # through the public application. One active invite can exist per email address.

data/sig/growsurf_ruby/models/campaign/participant.rbs

@@ -26,6 +26,7 @@ module GrowsurfRuby
           is_new: bool,
           is_winner: bool,
           last_name: String?,
+          lead_count: Integer,
           metadata: ::Hash[Symbol, top],
           mobile_instance_id: String?,
           monthly_referrals: ::Array[String],
@@ -118,6 +119,12 @@ module GrowsurfRuby
 
         attr_accessor last_name: String?
 
+
+        attr_reader lead_count: Integer?
+
+
+        def lead_count=: (Integer) -> Integer
+
         attr_reader metadata: ::Hash[Symbol, top]?
 
         def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
@@ -218,6 +225,7 @@ module GrowsurfRuby
           ?is_new: bool,
           ?is_winner: bool,
           ?last_name: String?,
+          ?lead_count: Integer,
           ?metadata: ::Hash[Symbol, top],
           ?mobile_instance_id: String?,
           ?monthly_referrals: ::Array[String],
@@ -263,6 +271,7 @@ module GrowsurfRuby
           is_new: bool,
           is_winner: bool,
           last_name: String?,
+          lead_count: Integer,
           metadata: ::Hash[Symbol, top],
           mobile_instance_id: String?,
           monthly_referrals: ::Array[String],
@@ -330,6 +339,7 @@ module GrowsurfRuby
             ip_address: String?,
             is_winner: bool,
             last_name: String?,
+            lead_count: Integer,
             metadata: ::Hash[Symbol, top],
             monthly_rank: Integer,
             monthly_referral_count: Integer,
@@ -390,6 +400,12 @@ module GrowsurfRuby
 
           attr_accessor last_name: String?
 
+
+          attr_reader lead_count: Integer?
+
+
+          def lead_count=: (Integer) -> Integer
+
           attr_reader metadata: ::Hash[Symbol, top]?
 
           def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
@@ -467,6 +483,7 @@ module GrowsurfRuby
             ?ip_address: String?,
             ?is_winner: bool,
             ?last_name: String?,
+            ?lead_count: Integer,
             ?metadata: ::Hash[Symbol, top],
             ?monthly_rank: Integer,
             ?monthly_referral_count: Integer,
@@ -497,6 +514,7 @@ module GrowsurfRuby
             ip_address: String?,
             is_winner: bool,
             last_name: String?,
+            lead_count: Integer,
             metadata: ::Hash[Symbol, top],
             monthly_rank: Integer,
             monthly_referral_count: Integer,

data/sig/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rbs

@@ -0,0 +1,88 @@
+module GrowsurfRuby
+  module Models
+    type campaign_capture_referral_flow_screenshots_response =
+      {
+        expires_at: Time,
+        generated_at: Time,
+        screenshots: ::Array[GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot]
+      }
+
+    class CampaignCaptureReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor expires_at: Time
+
+      attr_accessor generated_at: Time
+
+      attr_accessor screenshots: ::Array[GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot]
+
+      def initialize: (
+        expires_at: Time,
+        generated_at: Time,
+        screenshots: ::Array[GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot]
+      ) -> void
+
+      def to_hash: -> {
+        expires_at: Time,
+        generated_at: Time,
+        screenshots: ::Array[GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot]
+      }
+
+      type screenshot =
+        {
+          content_type: String,
+          expires_at: Time,
+          height: Integer,
+          label: String,
+          url: String,
+          view: GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::view,
+          width: Integer
+        }
+
+      class Screenshot < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor content_type: String
+
+        attr_accessor expires_at: Time
+
+        attr_accessor height: Integer
+
+        attr_accessor label: String
+
+        attr_accessor url: String
+
+        attr_accessor view: GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::view
+
+        attr_accessor width: Integer
+
+        def initialize: (
+          content_type: String,
+          expires_at: Time,
+          height: Integer,
+          label: String,
+          url: String,
+          view: GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::view,
+          width: Integer
+        ) -> void
+
+        def to_hash: -> {
+          content_type: String,
+          expires_at: Time,
+          height: Integer,
+          label: String,
+          url: String,
+          view: GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::view,
+          width: Integer
+        }
+
+        type view = :referrer | :referredFriend
+
+        module View
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFERRER: :referrer
+          REFERRED_FRIEND: :referredFriend
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse::Screenshot::view]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -57,6 +57,11 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
 
+      def capture_referral_flow_screenshots: (
+        String id,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::CampaignCaptureReferralFlowScreenshotsResponse
+
       def create_affiliate_invite: (
         String id,
         email: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growsurf-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Growsurf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-19 00:00:00.000000000 Z
+date: 2026-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -156,6 +156,7 @@ files:
 - lib/growsurf_ruby/models/campaign/webhook_test_response.rb
 - lib/growsurf_ruby/models/campaign/webhook_update_params.rb
 - lib/growsurf_ruby/models/campaign_activation_analytics_response.rb
+- lib/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rb
 - lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb
 - lib/growsurf_ruby/models/campaign_create_mobile_participant_token_params.rb
 - lib/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rb
@@ -311,6 +312,7 @@ files:
 - rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi
 - rbi/growsurf_ruby/models/campaign/webhook_update_params.rbi
 - rbi/growsurf_ruby/models/campaign_activation_analytics_response.rbi
+- rbi/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rbi
 - rbi/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbi
 - rbi/growsurf_ruby/models/campaign_create_mobile_participant_token_params.rbi
 - rbi/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rbi
@@ -465,6 +467,7 @@ files:
 - sig/growsurf_ruby/models/campaign/webhook_test_response.rbs
 - sig/growsurf_ruby/models/campaign/webhook_update_params.rbs
 - sig/growsurf_ruby/models/campaign_activation_analytics_response.rbs
+- sig/growsurf_ruby/models/campaign_capture_referral_flow_screenshots_response.rbs
 - sig/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbs
 - sig/growsurf_ruby/models/campaign_create_mobile_participant_token_params.rbs
 - sig/growsurf_ruby/models/campaign_create_mobile_participant_token_response.rbs