growsurf-ruby 0.8.0 → 1.1.0

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#email
+      class ParticipantEmailResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute status
+        #   The email was accepted for delivery.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantEmailResponse::Status]
+        required :status, enum: -> { GrowsurfRuby::Campaign::ParticipantEmailResponse::Status }
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(status:, success:)
+        #   @param status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantEmailResponse::Status] The email was accepted for delivery.
+        #
+        #   @param success [Boolean]
+
+        # The email was accepted for delivery.
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantEmailResponse#status
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          QUEUED = :queued
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_activity_logs
+      class ParticipantListActivityLogsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!attribute limit
+        #   Number of logs to return (1–100, default 20).
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute offset
+        #   Number of logs to skip.
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
+        # @!method initialize(id:, participant_id_or_email:, limit: nil, offset: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [String]
+        #
+        #   @param limit [Integer] Number of logs to return (1–100, default 20).
+        #
+        #   @param offset [Integer] Number of logs to skip.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#retrieve_analytics
+      class ParticipantRetrieveAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!attribute days
+        #   Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #
+        #   @return [Integer, nil]
+        optional :days, Integer
+
+        # @!attribute end_date
+        #   End date of the analytics timeframe as a Unix timestamp in milliseconds.
+        #   Required if `days` is not set.
+        #
+        #   @return [Integer, nil]
+        optional :end_date, Integer
+
+        # @!attribute include
+        #   Set to `series` to also return this participant's own activity per period.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include, nil]
+        optional :include, enum: -> { GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include }
+
+        # @!attribute interval
+        #   Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval, nil]
+        optional :interval, enum: -> { GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval }
+
+        # @!attribute start_date
+        #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+        #   Required if `days` is not set.
+        #
+        #   @return [Integer, nil]
+        optional :start_date, Integer
+
+        # @!method initialize(id:, participant_id_or_email:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams} for more
+        #   details.
+        #
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [String]
+        #
+        #   @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #
+        #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        #
+        #   @param include [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include] Set to `series` to also return this participant's own activity per period.
+        #
+        #   @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        #
+        #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # Set to `series` to also return this participant's own activity per period.
+        module Include
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SERIES = :series
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        module Interval
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          DAY = :day
+          WEEK = :week
+          MONTH = :month
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -39,6 +39,19 @@ module GrowsurfRuby
         #   @return [Hash{Symbol=>Object}, nil]
         optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
 
+        # @!attribute notes
+        #   Freeform internal notes about the participant (internal only, never exposed to
+        #   participants).
+        #
+        #   @return [String, nil]
+        optional :notes, String
+
+        # @!attribute paypal_email
+        #   The participant's PayPal email address, used for affiliate payouts.
+        #
+        #   @return [String, nil]
+        optional :paypal_email, String, api_name: :paypalEmail
+
         # @!attribute referral_status
         #
         #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus, nil]
@@ -61,7 +74,10 @@ module GrowsurfRuby
         #   @return [Array<String>, nil]
         optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
 
-        # @!method initialize(id:, participant_id_or_email:, email: nil, first_name: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        # @!method initialize(id:, participant_id_or_email:, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, paypal_email: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantUpdateParams} for more details.
+        #
         #   @param id [String]
         #
         #   @param participant_id_or_email [String]
@@ -74,6 +90,10 @@ module GrowsurfRuby
         #
         #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
         #
+        #   @param notes [String] Freeform internal notes about the participant (internal only, never exposed to pa
+        #
+        #   @param paypal_email [String] The participant's PayPal email address, used for affiliate payouts.
+        #
         #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus]
         #
         #   @param referred_by [String]

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

@@ -40,6 +40,9 @@ module GrowsurfRuby
         optional :conversions_required, Integer, api_name: :conversionsRequired, nil?: true
 
         # @!attribute coupon_code
+        #   Legacy static coupon code shown to the referrer in the reward-won email and
+        #   webhook. Display text only; superseded by a connected billing integration's
+        #   issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :coupon_code, String, api_name: :couponCode, nil?: true
@@ -69,16 +72,22 @@ module GrowsurfRuby
                  nil?: true
 
         # @!attribute next_milestone_prefix
+        #   Text shown before a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
 
         # @!attribute next_milestone_suffix
+        #   Text shown after a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
 
         # @!attribute number_of_winners
+        #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        #   `PER_MONTH` this many win each month, otherwise this many win in total.
         #
         #   @return [Integer, nil]
         optional :number_of_winners, Integer, api_name: :numberOfWinners, nil?: true
@@ -88,6 +97,14 @@ module GrowsurfRuby
         #   @return [Integer, nil]
         optional :order, Integer, nil?: true
 
+        # @!attribute referral_coupon_code
+        #   Legacy static coupon code shown to the referred friend (double-sided rewards)
+        #   in the reward-won email and webhook. Display text only; superseded by a
+        #   connected billing integration's issued coupon when one exists.
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
+
         # @!attribute referral_description
         #
         #   @return [String, nil]
@@ -100,7 +117,22 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::Boolean,
                  api_name: :referredRewardUpfront
 
-        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_description: nil, referred_reward_upfront: nil)
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue,
+                 nil?: true
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
+
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -113,7 +145,7 @@ module GrowsurfRuby
         #
         #   @param conversions_required [Integer, nil]
         #
-        #   @param coupon_code [String, nil]
+        #   @param coupon_code [String, nil] Legacy static coupon code shown to the referrer in the reward-won email and web
         #
         #   @param description [String, nil]
         #
@@ -123,17 +155,23 @@ module GrowsurfRuby
         #
         #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::Reward::LimitDuration, nil]
         #
-        #   @param next_milestone_prefix [String, nil]
+        #   @param next_milestone_prefix [String, nil] Text shown before a participant's referral count in milestone-progress copy. App
         #
-        #   @param next_milestone_suffix [String, nil]
+        #   @param next_milestone_suffix [String, nil] Text shown after a participant's referral count in milestone-progress copy. Appl
         #
-        #   @param number_of_winners [Integer, nil]
+        #   @param number_of_winners [Integer, nil] The number of winners (`LEADERBOARD` rewards only). With `limitDuration` `PER_MO
         #
         #   @param order [Integer, nil]
         #
+        #   @param referral_coupon_code [String, nil] Legacy static coupon code shown to the referred friend (double-sided rewards) in
+        #
         #   @param referral_description [String, nil]
         #
         #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
 
         # @see GrowsurfRuby::Models::Campaign::Reward#type
         module Type

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

@@ -26,6 +26,9 @@ module GrowsurfRuby
         optional :conversions_required, Integer, api_name: :conversionsRequired
 
         # @!attribute coupon_code
+        #   Legacy static coupon code shown to the referrer in the reward-won email and
+        #   webhook. Display text only; superseded by a connected billing integration's
+        #   issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :coupon_code, String, api_name: :couponCode
@@ -40,17 +43,16 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :image_url, String, api_name: :imageUrl
 
-        # @!attribute is_active
-        #
-        #   @return [Boolean, nil]
-        optional :is_active, GrowsurfRuby::Internal::Type::Boolean, api_name: :isActive
-
         # @!attribute is_unlimited
+        #   Whether the reward can be earned an unlimited number of times. Defaults to
+        #   `true`, except `MILESTONE` rewards, which can only be earned once.
         #
         #   @return [Boolean, nil]
         optional :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
 
         # @!attribute is_visible
+        #   Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        #   participants and no longer awarded, including those who already earned it.
         #
         #   @return [Boolean, nil]
         optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
@@ -74,16 +76,23 @@ module GrowsurfRuby
         optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
 
         # @!attribute next_milestone_prefix
+        #   Text shown before a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
 
         # @!attribute next_milestone_suffix
+        #   Text shown after a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
 
         # @!attribute number_of_winners
+        #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        #   `PER_MONTH` this many win each month, otherwise this many win in total;
+        #   omitting it defaults to `3`.
         #
         #   @return [Integer, nil]
         optional :number_of_winners, Integer, api_name: :numberOfWinners
@@ -94,6 +103,9 @@ module GrowsurfRuby
         optional :order, Integer
 
         # @!attribute referral_coupon_code
+        #   Legacy static coupon code shown to the referred friend (double-sided rewards)
+        #   in the reward-won email and webhook. Display text only; superseded by a
+        #   connected billing integration's issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :referral_coupon_code, String, api_name: :referralCouponCode
@@ -110,29 +122,46 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::Boolean,
                  api_name: :referredRewardUpfront
 
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Defaults to not tax-reportable (a purchase rebate).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue
+
         # @!attribute title
         #
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, title: nil, request_options: {})
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #   Used by tax documentation / 1099 reporting.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+
+        # @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::RewardCreateParams} for more details.
+        #
         #   @param type [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type]
         #
         #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure]
         #
         #   @param conversions_required [Integer]
         #
-        #   @param coupon_code [String]
+        #   @param coupon_code [String] Legacy static coupon code shown to the referrer in the reward-won email and web
         #
         #   @param description [String]
         #
         #   @param image_url [String]
         #
-        #   @param is_active [Boolean]
-        #
-        #   @param is_unlimited [Boolean]
+        #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
         #
-        #   @param is_visible [Boolean]
+        #   @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
         #
         #   @param limit [Integer]
         #
@@ -140,22 +169,26 @@ module GrowsurfRuby
         #
         #   @param metadata [Hash{Symbol=>Object}] Custom key/value metadata (single-level; values are stored as strings).
         #
-        #   @param next_milestone_prefix [String]
+        #   @param next_milestone_prefix [String] Text shown before a participant's referral count in milestone-progress copy. App
         #
-        #   @param next_milestone_suffix [String]
+        #   @param next_milestone_suffix [String] Text shown after a participant's referral count in milestone-progress copy. Appl
         #
-        #   @param number_of_winners [Integer]
+        #   @param number_of_winners [Integer] The number of winners (`LEADERBOARD` rewards only). With `limitDuration` `PER_MO
         #
         #   @param order [Integer]
         #
-        #   @param referral_coupon_code [String]
+        #   @param referral_coupon_code [String] Legacy static coupon code shown to the referred friend (double-sided rewards) in
         #
         #   @param referral_description [String]
         #
         #   @param referred_reward_upfront [Boolean]
         #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #
         #   @param title [String]
         #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the reward (the referrer's side of a double-sided reward). Use
+        #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
         # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#type

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

@@ -13,14 +13,14 @@ module GrowsurfRuby
         #   @return [String]
         required :id, String
 
-        # @!attribute reward_id
+        # @!attribute campaign_reward_id
         #
         #   @return [String]
-        required :reward_id, String
+        required :campaign_reward_id, String
 
-        # @!method initialize(id:, reward_id:, request_options: {})
+        # @!method initialize(id:, campaign_reward_id:, request_options: {})
         #   @param id [String]
-        #   @param reward_id [String]
+        #   @param campaign_reward_id [String]
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -13,10 +13,10 @@ module GrowsurfRuby
         #   @return [String]
         required :id, String
 
-        # @!attribute reward_id
+        # @!attribute campaign_reward_id
         #
         #   @return [String]
-        required :reward_id, String
+        required :campaign_reward_id, String
 
         # @!attribute commission_structure
         #
@@ -31,6 +31,9 @@ module GrowsurfRuby
         optional :conversions_required, Integer, api_name: :conversionsRequired
 
         # @!attribute coupon_code
+        #   Legacy static coupon code shown to the referrer in the reward-won email and
+        #   webhook. Display text only; superseded by a connected billing integration's
+        #   issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :coupon_code, String, api_name: :couponCode
@@ -45,17 +48,16 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :image_url, String, api_name: :imageUrl
 
-        # @!attribute is_active
-        #
-        #   @return [Boolean, nil]
-        optional :is_active, GrowsurfRuby::Internal::Type::Boolean, api_name: :isActive
-
         # @!attribute is_unlimited
+        #   Whether the reward can be earned an unlimited number of times. Defaults to
+        #   `true`, except `MILESTONE` rewards, which can only be earned once.
         #
         #   @return [Boolean, nil]
         optional :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
 
         # @!attribute is_visible
+        #   Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        #   participants and no longer awarded, including those who already earned it.
         #
         #   @return [Boolean, nil]
         optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
@@ -79,16 +81,23 @@ module GrowsurfRuby
         optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
 
         # @!attribute next_milestone_prefix
+        #   Text shown before a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
 
         # @!attribute next_milestone_suffix
+        #   Text shown after a participant's referral count in milestone-progress copy.
+        #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
         optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
 
         # @!attribute number_of_winners
+        #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
+        #   `PER_MONTH` this many win each month, otherwise this many win in total;
+        #   omitting it defaults to `3`.
         #
         #   @return [Integer, nil]
         optional :number_of_winners, Integer, api_name: :numberOfWinners
@@ -99,6 +108,9 @@ module GrowsurfRuby
         optional :order, Integer
 
         # @!attribute referral_coupon_code
+        #   Legacy static coupon code shown to the referred friend (double-sided rewards)
+        #   in the reward-won email and webhook. Display text only; superseded by a
+        #   connected billing integration's issued coupon when one exists.
         #
         #   @return [String, nil]
         optional :referral_coupon_code, String, api_name: :referralCouponCode
@@ -115,31 +127,48 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::Boolean,
                  api_name: :referredRewardUpfront
 
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Defaults to not tax-reportable (a purchase rebate).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue
+
         # @!attribute title
         #
         #   @return [String, nil]
         optional :title, String
 
-        # @!method initialize(id:, reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, title: nil, request_options: {})
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #   Used by tax documentation / 1099 reporting.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+
+        # @!method initialize(id:, campaign_reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::RewardUpdateParams} for more details.
+        #
         #   @param id [String]
         #
-        #   @param reward_id [String]
+        #   @param campaign_reward_id [String]
         #
         #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure]
         #
         #   @param conversions_required [Integer]
         #
-        #   @param coupon_code [String]
+        #   @param coupon_code [String] Legacy static coupon code shown to the referrer in the reward-won email and web
         #
         #   @param description [String]
         #
         #   @param image_url [String]
         #
-        #   @param is_active [Boolean]
-        #
-        #   @param is_unlimited [Boolean]
+        #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
         #
-        #   @param is_visible [Boolean]
+        #   @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
         #
         #   @param limit [Integer]
         #
@@ -147,22 +176,26 @@ module GrowsurfRuby
         #
         #   @param metadata [Hash{Symbol=>Object}] Custom key/value metadata (single-level; values are stored as strings).
         #
-        #   @param next_milestone_prefix [String]
+        #   @param next_milestone_prefix [String] Text shown before a participant's referral count in milestone-progress copy. App
         #
-        #   @param next_milestone_suffix [String]
+        #   @param next_milestone_suffix [String] Text shown after a participant's referral count in milestone-progress copy. Appl
         #
-        #   @param number_of_winners [Integer]
+        #   @param number_of_winners [Integer] The number of winners (`LEADERBOARD` rewards only). With `limitDuration` `PER_MO
         #
         #   @param order [Integer]
         #
-        #   @param referral_coupon_code [String]
+        #   @param referral_coupon_code [String] Legacy static coupon code shown to the referred friend (double-sided rewards) in
         #
         #   @param referral_description [String]
         #
         #   @param referred_reward_upfront [Boolean]
         #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #
         #   @param title [String]
         #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the reward (the referrer's side of a double-sided reward). Use
+        #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
         # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#limit_duration