growsurf-ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 493b71b685dcab98c1c2633ab0c32d9339609bba972dafb665607039a0079142
-  data.tar.gz: 75af6a27ec19b8f9e1cc8cdf8b412c4c70f9405276f444f69b305c901ca51893
+  metadata.gz: 275aad4e60a6dbc15b0f7bdb1b09abb6ad493d1e08d1eb87aeb1f788240b1253
+  data.tar.gz: d729a0d1032edb387819583a90e76795d42386d90df6357036e958dc03b0004a
 SHA512:
-  metadata.gz: 50054ac45d5711ca710ae6f4c16d24d4c10954fc7c0f17e99f279531e318c86663ffd866cbf263380ccc8697a902ffd3c7d78389f11a31ec74ac4c046e09fbf2
-  data.tar.gz: 6de111fb82f96ea5dbdd3c43c5c98f039f3a250c71ebd193a9ae3244f3896df02eb3bd82a6f0143ed947bee2456a8cc1f7f08da8ef48b69da0860904730e0966
+  metadata.gz: 651d86c7678d8ed1cf2fbff0c70e458225bd0b1f912c49e1285c419f4d6c63ee03d022273753178d4fe21e3a37cfb953b688f0fe7015c6c818094eb239c2bc7c
+  data.tar.gz: d4a5a15415b2b9c8f3932d4a09c8d591ac221d7c279169654994f2c8da86027776b1fce197053a5c3ecc64942377da763a5e3c55b2f22eb3a3e93ade939ea6c4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.4.0](https://github.com/growsurf/growsurf-ruby/compare/v1.3.0...v1.4.0) (2026-08-25)
+
+
+### Features
+
+* **api:** add reward and commission event support ([a9d672f](https://github.com/growsurf/growsurf-ruby/commit/a9d672ff9fd34198b8919adbf207436a023841b4))
+
 ## [1.3.0](https://github.com/growsurf/growsurf-ruby/compare/v1.2.1...v1.3.0) (2026-08-23)
 
 

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

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

@@ -19,14 +19,16 @@ module GrowsurfRuby
         required :participant_id_or_email, String
 
         # @!attribute days
-        #   Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #   Last number of days for optional `series` and `email` analytics. Defaults to
+        #   365. Maximum 1825. Does not filter the top-level all-time totals.
         #
         #   @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.
+        #   End of a custom `series` and `email` analytics window as a Unix timestamp in
+        #   milliseconds. Set it together with `startDate`. Does not filter the top-level
+        #   all-time totals.
         #
         #   @return [Integer, nil]
         optional :end_date, Integer
@@ -50,8 +52,9 @@ module GrowsurfRuby
         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.
+        #   Start of a custom `series` and `email` analytics window as a Unix timestamp in
+        #   milliseconds. Set it together with `endDate`. Does not filter the top-level
+        #   all-time totals.
         #
         #   @return [Integer, nil]
         optional :start_date, Integer
@@ -65,15 +68,15 @@ module GrowsurfRuby
         #
         #   @param participant_id_or_email [String]
         #
-        #   @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #   @param days [Integer] Last number of days for optional `series` and `email` analytics. Defaults to 365. Maxi
         #
-        #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        #   @param end_date [Integer] End of a custom `series` and `email` analytics window as a Unix timestamp in milli
         #
         #   @param include [String] Comma-separated optional data. `series` returns this participant's own activity
         #
         #   @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used when `include` contains `series`).
         #
-        #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        #   @param start_date [Integer] Start of a custom `series` and `email` analytics window as a Unix timestamp in mi
         #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -93,6 +93,7 @@ module GrowsurfRuby
 
           PENDING = :PENDING
           FULFILLED = :FULFILLED
+          CANCELLED = :CANCELLED
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -52,6 +52,14 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :description, String, nil?: true
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Present only for
+        #   `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        #   Rewards return `CONVERSION`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::Reward::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::Reward::Event }, nil?: true
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -145,7 +153,7 @@ module GrowsurfRuby
         #   @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, is_visible: 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, title: nil, value: nil)
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_visible: 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, title: nil, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -162,6 +170,8 @@ module GrowsurfRuby
         #
         #   @param description [String, nil]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::Reward::Event, nil] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String, nil]
         #
         #   @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
@@ -204,6 +214,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::Campaign::Reward#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::Reward#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

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

@@ -38,6 +38,15 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Use `LEAD` or
+        #   `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+        #   be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+        #   `MILESTONE` rewards. When omitted, it defaults to `CONVERSION`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::Event }
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -143,7 +152,7 @@ module GrowsurfRuby
         #   @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: {})
+        # @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: 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.
         #
@@ -157,6 +166,8 @@ module GrowsurfRuby
         #
         #   @param description [String]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String]
         #
         #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
@@ -205,6 +216,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

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

@@ -43,6 +43,15 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Use `LEAD` or
+        #   `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+        #   be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+        #   `MILESTONE` rewards. When omitted, the stored event is preserved.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::RewardUpdateParams::Event }
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -148,7 +157,7 @@ module GrowsurfRuby
         #   @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: {})
+        # @!method initialize(id:, campaign_reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: 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.
         #
@@ -164,6 +173,8 @@ module GrowsurfRuby
         #
         #   @param description [String]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String]
         #
         #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
@@ -198,6 +209,17 @@ module GrowsurfRuby
         #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
+        # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

data/lib/growsurf_ruby/models/campaign.rb

@@ -120,6 +120,14 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :description, String, nil?: true
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Present only for
+        #   `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        #   Rewards return `CONVERSION`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::CampaignAPI::Reward::Event }, nil?: true
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -200,7 +208,7 @@ module GrowsurfRuby
         #   @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)
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: 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]
@@ -217,6 +225,8 @@ module GrowsurfRuby
         #
         #   @param description [String, nil]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Event, nil] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String, nil]
         #
         #   @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
@@ -255,6 +265,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::CampaignAPI::Reward#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::CampaignAPI::Reward#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

data/lib/growsurf_ruby/models/commission_structure.rb

@@ -32,9 +32,10 @@ module GrowsurfRuby
       optional :duration_in_months, Integer, api_name: :durationInMonths, nil?: true
 
       # @!attribute event
+      #   The event that generates a commission. Missing legacy values read as `SALE`.
       #
-      #   @return [String, nil]
-      optional :event, String, nil?: true
+      #   @return [Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil]
+      optional :event, enum: -> { GrowsurfRuby::CommissionStructure::Event }, nil?: true
 
       # @!attribute has_intro
       #
@@ -112,7 +113,7 @@ module GrowsurfRuby
       #   @param approval_required [Boolean, nil]
       #   @param duration [String, nil]
       #   @param duration_in_months [Integer, nil]
-      #   @param event [String, nil]
+      #   @param event [Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil]
       #   @param has_intro [Boolean, nil]
       #   @param has_max_amount [Boolean, nil]
       #   @param hold_duration [Integer, nil]
@@ -128,6 +129,18 @@ module GrowsurfRuby
       #   @param percent [Float, nil]
       #   @param type [Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil]
 
+      # @see GrowsurfRuby::Models::CommissionStructure#event
+      module Event
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CLICK = :CLICK
+        LEAD = :LEAD
+        SALE = :SALE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see GrowsurfRuby::Models::CommissionStructure#type
       module Type
         extend GrowsurfRuby::Internal::Type::Enum

data/lib/growsurf_ruby/models/participant_commission_list.rb

@@ -46,6 +46,12 @@ module GrowsurfRuby
         #   @return [String]
         required :currency_iso, String, api_name: :currencyISO
 
+        # @!attribute event
+        #   The event that generated this commission. Legacy commissions return `SALE`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Event]
+        required :event, enum: -> { GrowsurfRuby::ParticipantCommissionList::Commission::Event }
+
         # @!attribute referred_id
         #
         #   @return [String]
@@ -129,11 +135,12 @@ module GrowsurfRuby
                  api_name: :saleAmountInCampaignCurrency,
                  nil?: true
 
-        # @!method initialize(id:, amount:, created_at:, currency_iso:, referred_id:, referrer_id:, sale_amount:, status:, amount_in_campaign_currency: nil, approved_at: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, fx_error: nil, hold_duration: nil, paid_at: nil, payout_queued_at: nil, provider: nil, reversed_at: nil, sale_amount_in_campaign_currency: nil)
+        # @!method initialize(id:, amount:, created_at:, currency_iso:, event:, referred_id:, referrer_id:, sale_amount:, status:, amount_in_campaign_currency: nil, approved_at: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, fx_error: nil, hold_duration: nil, paid_at: nil, payout_queued_at: nil, provider: nil, reversed_at: nil, sale_amount_in_campaign_currency: nil)
         #   @param id [String]
         #   @param amount [Integer, nil]
         #   @param created_at [Integer]
         #   @param currency_iso [String]
+        #   @param event [Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Event] The event that generated this commission. Legacy commissions return `SALE`.
         #   @param referred_id [String]
         #   @param referrer_id [String]
         #   @param sale_amount [Integer, nil]
@@ -151,6 +158,17 @@ module GrowsurfRuby
         #   @param reversed_at [Integer]
         #   @param sale_amount_in_campaign_currency [Integer, nil]
 
+        # @see GrowsurfRuby::Models::ParticipantCommissionList::Commission#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          SALE = :SALE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::ParticipantCommissionList::Commission#status
         module Status
           extend GrowsurfRuby::Internal::Type::Enum

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

@@ -687,7 +687,9 @@ module GrowsurfRuby
         # for `sent` (accepted for delivery), `delivered`, `opened`, `clicked`,
         # `bounced`, and `spamComplaints` metrics attributed to this participant,
         # including invitations they sent. Use `include=email,series` to include the
-        # same counts in each UTC series bucket.
+        # same counts in each UTC series bucket. `days`, `startDate`, and `endDate`
+        # filter only the optional `series` and `email` data. They do not filter the
+        # top-level `analytics`, `ranks`, or `shareCount` values.
         #
         # @overload retrieve_analytics(participant_id_or_email, id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
         #
@@ -695,15 +697,15 @@ module GrowsurfRuby
         #
         # @param id [String] GrowSurf program ID.
         #
-        # @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        # @param days [Integer] Last number of days for optional `series` and `email` analytics. Defaults to 365. Maxi
         #
-        # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        # @param end_date [Integer] End of a custom `series` and `email` analytics window as a Unix timestamp in milli
         #
         # @param include [String] Comma-separated optional data. `series` returns this participant's own activity
         #
         # @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used when `include` contains `series`).
         #
-        # @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        # @param start_date [Integer] Start of a custom `series` and `email` analytics window as a Unix timestamp in mi
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -30,7 +30,7 @@ module GrowsurfRuby
         # Enabling an active reward of a type automatically enables that reward type on
         # the program.
         #
-        # @overload create(id, 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: {})
+        # @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: 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: {})
         #
         # @param id [String] Path param: GrowSurf program ID.
         #
@@ -44,6 +44,8 @@ module GrowsurfRuby
         #
         # @param description [String] Body param
         #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event] Body param: The referral event that earns this Campaign Reward. Use `LEAD` or `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. When omitted, it defaults to `CONVERSION`.
+        #
         # @param image_url [String] Body param
         #
         # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
@@ -98,7 +100,7 @@ module GrowsurfRuby
         # copy; removing a key that campaign copy still references returns a `409` listing
         # the referencing fields.
         #
-        # @overload update(campaign_reward_id, 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: {})
+        # @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: 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: {})
         #
         # @param campaign_reward_id [String] Path param: Campaign reward ID.
         #
@@ -112,6 +114,8 @@ module GrowsurfRuby
         #
         # @param description [String] Body param
         #
+        # @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event] Body param: The referral event that earns this Campaign Reward. Use `LEAD` or `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. When omitted, the stored event is preserved.
+        #
         # @param image_url [String] Body param
         #
         # @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul

data/lib/growsurf_ruby/version.rb

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

data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi

@@ -21,15 +21,17 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :participant_id_or_email
 
-        # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        # Last number of days for optional `series` and `email` analytics. Defaults to 365.
+        # Maximum 1825. Does not filter the top-level all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :days
 
         sig { params(days: Integer).void }
         attr_writer :days
 
-        # End date of the analytics timeframe as a Unix timestamp in milliseconds.
-        # Required if `days` is not set.
+        # End of a custom `series` and `email` analytics window as a Unix timestamp in
+        # milliseconds. Set it together with `startDate`. Does not filter the top-level
+        # all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :end_date
 
@@ -67,8 +69,9 @@ module GrowsurfRuby
         end
         attr_writer :interval
 
-        # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
-        # Required if `days` is not set.
+        # Start of a custom `series` and `email` analytics window as a Unix timestamp in
+        # milliseconds. Set it together with `endDate`. Does not filter the top-level
+        # all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :start_date
 
@@ -91,10 +94,12 @@ module GrowsurfRuby
         def self.new(
           id:,
           participant_id_or_email:,
-          # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+          # Last number of days for optional `series` and `email` analytics. Defaults to 365.
+          # Maximum 1825. Does not filter the top-level all-time totals.
           days: nil,
-          # End date of the analytics timeframe as a Unix timestamp in milliseconds.
-          # Required if `days` is not set.
+          # End of a custom `series` and `email` analytics window as a Unix timestamp in
+          # milliseconds. Set it together with `startDate`. Does not filter the top-level
+          # all-time totals.
           end_date: nil,
           # Comma-separated optional data. `series` returns this participant's own activity per
           # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
@@ -106,8 +111,9 @@ module GrowsurfRuby
           # Bucket size for the `series` (only used when `include` contains `series`). Defaults to
           # `day`.
           interval: nil,
-          # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
-          # Required if `days` is not set.
+          # Start of a custom `series` and `email` analytics window as a Unix timestamp in
+          # milliseconds. Set it together with `endDate`. Does not filter the top-level
+          # all-time totals.
           start_date: nil,
           request_options: {}
         )

data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi

@@ -168,6 +168,11 @@ module GrowsurfRuby
               :FULFILLED,
               GrowsurfRuby::Campaign::ParticipantReward::Status::TaggedSymbol
             )
+          CANCELLED =
+            T.let(
+              :CANCELLED,
+              GrowsurfRuby::Campaign::ParticipantReward::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/growsurf_ruby/models/campaign/reward.rbi

@@ -50,6 +50,18 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
+        # The referral event that earns this Campaign Reward. Present only for
+        # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        # Rewards return `CONVERSION`.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :event
+
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
@@ -144,6 +156,10 @@ module GrowsurfRuby
             conversions_required: T.nilable(Integer),
             coupon_code: T.nilable(String),
             description: T.nilable(String),
+            event:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::Reward::Event::OrSymbol
+              ),
             image_url: T.nilable(String),
             is_visible: T::Boolean,
             limit: T.nilable(Integer),
@@ -176,6 +192,10 @@ module GrowsurfRuby
           # issued coupon when one exists.
           coupon_code: nil,
           description: nil,
+          # The referral event that earns this Campaign Reward. Present only for
+          # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+          # Rewards return `CONVERSION`.
+          event: nil,
           image_url: nil,
           # Whether the reward is enabled. When `false` the reward is disabled: hidden from
           # participants and no longer awarded, including those who already earned it.
@@ -220,6 +240,10 @@ module GrowsurfRuby
               conversions_required: T.nilable(Integer),
               coupon_code: T.nilable(String),
               description: T.nilable(String),
+              event:
+                T.nilable(
+                  GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+                ),
               image_url: T.nilable(String),
               is_visible: T::Boolean,
               limit: T.nilable(Integer),
@@ -289,6 +313,37 @@ module GrowsurfRuby
           end
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::Models::Campaign::Reward::Event)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(
+              :LEAD,
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum