growsurf-ruby 1.2.1 → 1.4.0

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

@@ -21,40 +21,37 @@ 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
 
         sig { params(end_date: Integer).void }
         attr_writer :end_date
 
-        # Set to `series` to also return this participant's own activity per period.
-        sig do
-          returns(
-            T.nilable(
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
-            )
-          )
-        end
+        # Comma-separated optional data. `series` returns this participant's own activity per
+        # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+        # `spamComplaints`, and per-email-type metrics attributed to the participant for the
+        # requested analytics window (including invitations they sent). Request both in either
+        # order to add email counts to every series item for emails sent during that period. Only
+        # documented tokens are accepted; an unknown token returns `400`.
+        sig { returns(T.nilable(String)) }
         attr_reader :include
 
-        sig do
-          params(
-            include:
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
-          ).void
-        end
+        sig { params(include: String).void }
         attr_writer :include
 
-        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # Bucket size for the `series` (only used when `include` contains `series`). Defaults to
+        # `day`.
         sig do
           returns(
             T.nilable(
@@ -72,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
 
@@ -86,8 +84,7 @@ module GrowsurfRuby
             participant_id_or_email: String,
             days: Integer,
             end_date: Integer,
-            include:
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+            include: String,
             interval:
               GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
             start_date: Integer,
@@ -97,17 +94,26 @@ 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,
-          # Set to `series` to also return this participant's own activity per period.
+          # Comma-separated optional data. `series` returns this participant's own activity per
+          # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+          # `spamComplaints`, and per-email-type metrics attributed to the participant for the
+          # requested analytics window (including invitations they sent). Request both in either
+          # order to add email counts to every series item for emails sent during that period.
+          # Only documented tokens are accepted; an unknown token returns `400`.
           include: nil,
-          # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+          # 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: {}
         )
@@ -120,8 +126,7 @@ module GrowsurfRuby
               participant_id_or_email: String,
               days: Integer,
               end_date: Integer,
-              include:
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+              include: String,
               interval:
                 GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
               start_date: Integer,
@@ -132,37 +137,8 @@ module GrowsurfRuby
         def to_hash
         end
 
-        # Set to `series` to also return this participant's own activity per period.
-        module Include
-          extend GrowsurfRuby::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          SERIES =
-            T.let(
-              :series,
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # Bucket size for the `series` (only used when `include` contains `series`). Defaults to
+        # `day`.
         module Interval
           extend GrowsurfRuby::Internal::Type::Enum
 

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/participant_update_params.rbi

@@ -21,6 +21,26 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :participant_id_or_email
 
+        # Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a
+        # participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected
+        # for non-affiliates.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol
+            )
+          )
+        end
+        attr_reader :affiliate_status
+
+        sig do
+          params(
+            affiliate_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol
+          ).void
+        end
+        attr_writer :affiliate_status
+
         sig { returns(T.nilable(String)) }
         attr_reader :email
 
@@ -54,13 +74,6 @@ module GrowsurfRuby
         sig { params(notes: String).void }
         attr_writer :notes
 
-        # The participant's PayPal email address, used for affiliate payouts.
-        sig { returns(T.nilable(String)) }
-        attr_reader :paypal_email
-
-        sig { params(paypal_email: String).void }
-        attr_writer :paypal_email
-
         sig do
           returns(
             T.nilable(
@@ -100,12 +113,13 @@ module GrowsurfRuby
           params(
             id: String,
             participant_id_or_email: String,
+            affiliate_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
             email: String,
             first_name: String,
             last_name: String,
             metadata: T::Hash[Symbol, T.anything],
             notes: String,
-            paypal_email: String,
             referral_status:
               GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
             referred_by: String,
@@ -117,6 +131,10 @@ module GrowsurfRuby
         def self.new(
           id:,
           participant_id_or_email:,
+          # Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a
+          # participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected
+          # for non-affiliates.
+          affiliate_status: nil,
           email: nil,
           first_name: nil,
           last_name: nil,
@@ -125,8 +143,6 @@ module GrowsurfRuby
           # Freeform internal notes about the participant (internal only, never exposed to
           # participants).
           notes: nil,
-          # The participant's PayPal email address, used for affiliate payouts.
-          paypal_email: nil,
           referral_status: nil,
           referred_by: nil,
           unsubscribed: nil,
@@ -140,12 +156,13 @@ module GrowsurfRuby
             {
               id: String,
               participant_id_or_email: String,
+              affiliate_status:
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
               email: String,
               first_name: String,
               last_name: String,
               metadata: T::Hash[Symbol, T.anything],
               notes: String,
-              paypal_email: String,
               referral_status:
                 GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
               referred_by: String,
@@ -158,6 +175,45 @@ module GrowsurfRuby
         def to_hash
         end
 
+        module AffiliateStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APPROVED =
+            T.let(
+              :APPROVED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :SUSPENDED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+          BANNED =
+            T.let(
+              :BANNED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module ReferralStatus
           extend GrowsurfRuby::Internal::Type::Enum
 

data/rbi/growsurf_ruby/models/campaign/referral_source.rbi

@@ -17,6 +17,15 @@ module GrowsurfRuby
             :PARTICIPANT,
             GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol
           )
+        DELETED_PARTICIPANT =
+          T.let(
+            :DELETED_PARTICIPANT,
+            GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol
+          )
+        IMPORT =
+          T.let(:IMPORT, GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
+        MANUAL =
+          T.let(:MANUAL, GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
 
         sig do
           override.returns(

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

@@ -50,9 +50,29 @@ 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
 
+        # Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        # participants and no longer awarded, including those who already earned it.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_visible
+
+        sig { params(is_visible: T::Boolean).void }
+        attr_writer :is_visible
+
         # `-1` represents an unlimited reward in REST responses.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :limit
@@ -99,7 +119,7 @@ module GrowsurfRuby
         sig { params(referred_reward_upfront: T::Boolean).void }
         attr_writer :referred_reward_upfront
 
-        # Tax valuation for the referred friend's side of a double-sided reward.
+        # Tax treatment override for the referred friend's side of a double-sided reward.
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :referred_value
 
@@ -110,6 +130,10 @@ module GrowsurfRuby
         end
         attr_writer :referred_value
 
+        # The reward title (internal label).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :title
+
         # Tax valuation for the reward (the referrer's side of a double-sided reward).
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :value
@@ -132,7 +156,12 @@ 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),
             limit_duration:
               T.nilable(
@@ -146,6 +175,7 @@ module GrowsurfRuby
             referral_description: T.nilable(String),
             referred_reward_upfront: T::Boolean,
             referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
+            title: T.nilable(String),
             value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
           ).returns(T.attached_class)
         end
@@ -162,7 +192,14 @@ 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.
+          is_visible: nil,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
           limit_duration: nil,
@@ -182,8 +219,10 @@ module GrowsurfRuby
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,
-          # Tax valuation for the referred friend's side of a double-sided reward.
+          # Tax treatment override for the referred friend's side of a double-sided reward.
           referred_value: nil,
+          # The reward title (internal label).
+          title: nil,
           # Tax valuation for the reward (the referrer's side of a double-sided reward).
           value: nil
         )
@@ -201,7 +240,12 @@ 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),
               limit_duration:
                 T.nilable(
@@ -215,6 +259,7 @@ module GrowsurfRuby
               referral_description: T.nilable(String),
               referred_reward_upfront: T::Boolean,
               referred_value: T.nilable(GrowsurfRuby::RewardTaxValuation),
+              title: T.nilable(String),
               value: T.nilable(GrowsurfRuby::RewardTaxValuation)
             }
           )
@@ -268,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
 

data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi

@@ -53,6 +53,27 @@ module GrowsurfRuby
         sig { params(description: String).void }
         attr_writer :description
 
+        # 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`.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol
+            )
+          )
+        end
+        attr_reader :event
+
+        sig do
+          params(
+            event:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol
+          ).void
+        end
+        attr_writer :event
+
         sig { returns(T.nilable(String)) }
         attr_reader :image_url
 
@@ -157,8 +178,8 @@ module GrowsurfRuby
         sig { params(referred_reward_upfront: T::Boolean).void }
         attr_writer :referred_reward_upfront
 
-        # Tax valuation for the referred friend's side of a double-sided reward.
-        # Defaults to not tax-reportable (a purchase rebate).
+        # Tax treatment override for the referred friend's side of a double-sided reward.
+        # Defaults to the program's confirmed default.
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :referred_value
 
@@ -189,6 +210,8 @@ module GrowsurfRuby
             conversions_required: Integer,
             coupon_code: String,
             description: String,
+            event:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
             image_url: String,
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
@@ -218,6 +241,11 @@ module GrowsurfRuby
           # issued coupon when one exists.
           coupon_code: nil,
           description: nil,
+          # 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`.
+          event: nil,
           image_url: nil,
           # Whether the reward can be earned an unlimited number of times. Defaults to
           # `true`, except `MILESTONE` rewards, which can only be earned once.
@@ -246,8 +274,8 @@ module GrowsurfRuby
           referral_coupon_code: nil,
           referral_description: nil,
           referred_reward_upfront: nil,
-          # Tax valuation for the referred friend's side of a double-sided reward.
-          # Defaults to not tax-reportable (a purchase rebate).
+          # Tax treatment override for the referred friend's side of a double-sided reward.
+          # Defaults to the program's confirmed default.
           referred_value: nil,
           title: nil,
           # Tax valuation for the reward (the referrer's side of a double-sided reward).
@@ -266,6 +294,8 @@ module GrowsurfRuby
               conversions_required: Integer,
               coupon_code: String,
               description: String,
+              event:
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
               image_url: String,
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
@@ -339,6 +369,40 @@ module GrowsurfRuby
           end
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(
+              :LEAD,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::TaggedSymbol
+            )
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum