growsurf-ruby 1.3.0 → 1.5.0

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

@@ -44,7 +44,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :coupon_code
 
-        sig { params(coupon_code: String).void }
+        sig { params(coupon_code: T.nilable(String)).void }
         attr_writer :coupon_code
 
         sig { returns(T.nilable(String)) }
@@ -53,10 +53,31 @@ 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
 
-        sig { params(image_url: String).void }
+        sig { params(image_url: T.nilable(String)).void }
         attr_writer :image_url
 
         # Whether the reward can be earned an unlimited number of times. Defaults to
@@ -110,7 +131,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_prefix
 
-        sig { params(next_milestone_prefix: String).void }
+        sig { params(next_milestone_prefix: T.nilable(String)).void }
         attr_writer :next_milestone_prefix
 
         # Text shown after a participant's referral count in milestone-progress copy.
@@ -118,7 +139,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_suffix
 
-        sig { params(next_milestone_suffix: String).void }
+        sig { params(next_milestone_suffix: T.nilable(String)).void }
         attr_writer :next_milestone_suffix
 
         # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
@@ -142,13 +163,13 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :referral_coupon_code
 
-        sig { params(referral_coupon_code: String).void }
+        sig { params(referral_coupon_code: T.nilable(String)).void }
         attr_writer :referral_coupon_code
 
         sig { returns(T.nilable(String)) }
         attr_reader :referral_description
 
-        sig { params(referral_description: String).void }
+        sig { params(referral_description: T.nilable(String)).void }
         attr_writer :referral_description
 
         sig { returns(T.nilable(T::Boolean)) }
@@ -163,7 +184,10 @@ module GrowsurfRuby
         attr_reader :referred_value
 
         sig do
-          params(referred_value: GrowsurfRuby::RewardTaxValuation::OrHash).void
+          params(
+            referred_value:
+              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
         end
         attr_writer :referred_value
 
@@ -178,7 +202,11 @@ module GrowsurfRuby
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :value
 
-        sig { params(value: GrowsurfRuby::RewardTaxValuation::OrHash).void }
+        sig do
+          params(
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
         attr_writer :value
 
         sig do
@@ -187,25 +215,28 @@ module GrowsurfRuby
               GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::OrSymbol,
             commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
             conversions_required: Integer,
-            coupon_code: String,
+            coupon_code: T.nilable(String),
             description: String,
-            image_url: String,
+            event:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
+            image_url: T.nilable(String),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
             limit_duration:
               GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::OrSymbol,
             metadata: T::Hash[Symbol, T.anything],
-            next_milestone_prefix: String,
-            next_milestone_suffix: String,
+            next_milestone_prefix: T.nilable(String),
+            next_milestone_suffix: T.nilable(String),
             number_of_winners: Integer,
             order: Integer,
-            referral_coupon_code: String,
-            referral_description: String,
+            referral_coupon_code: T.nilable(String),
+            referral_description: T.nilable(String),
             referred_reward_upfront: T::Boolean,
-            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            referred_value:
+              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
             title: String,
-            value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -218,6 +249,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.
@@ -264,25 +300,28 @@ module GrowsurfRuby
                 GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::OrSymbol,
               commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
               conversions_required: Integer,
-              coupon_code: String,
+              coupon_code: T.nilable(String),
               description: String,
-              image_url: String,
+              event:
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
+              image_url: T.nilable(String),
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,
               limit_duration:
                 GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration::OrSymbol,
               metadata: T::Hash[Symbol, T.anything],
-              next_milestone_prefix: String,
-              next_milestone_suffix: String,
+              next_milestone_prefix: T.nilable(String),
+              next_milestone_suffix: T.nilable(String),
               number_of_winners: Integer,
               order: Integer,
-              referral_coupon_code: String,
-              referral_description: String,
+              referral_coupon_code: T.nilable(String),
+              referral_description: T.nilable(String),
               referred_reward_upfront: T::Boolean,
-              referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+              referred_value:
+                T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
               title: String,
-              value: GrowsurfRuby::RewardTaxValuation::OrHash,
+              value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
               request_options: GrowsurfRuby::RequestOptions
             }
           )
@@ -339,6 +378,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
 

data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi

@@ -43,7 +43,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :coupon_code
 
-        sig { params(coupon_code: String).void }
+        sig { params(coupon_code: T.nilable(String)).void }
         attr_writer :coupon_code
 
         sig { returns(T.nilable(String)) }
@@ -52,10 +52,31 @@ 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, the stored event is preserved.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol
+            )
+          )
+        end
+        attr_reader :event
+
+        sig do
+          params(
+            event:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol
+          ).void
+        end
+        attr_writer :event
+
         sig { returns(T.nilable(String)) }
         attr_reader :image_url
 
-        sig { params(image_url: String).void }
+        sig { params(image_url: T.nilable(String)).void }
         attr_writer :image_url
 
         # Whether the reward can be earned an unlimited number of times. Defaults to
@@ -109,7 +130,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_prefix
 
-        sig { params(next_milestone_prefix: String).void }
+        sig { params(next_milestone_prefix: T.nilable(String)).void }
         attr_writer :next_milestone_prefix
 
         # Text shown after a participant's referral count in milestone-progress copy.
@@ -117,7 +138,7 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :next_milestone_suffix
 
-        sig { params(next_milestone_suffix: String).void }
+        sig { params(next_milestone_suffix: T.nilable(String)).void }
         attr_writer :next_milestone_suffix
 
         # The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
@@ -141,13 +162,13 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_reader :referral_coupon_code
 
-        sig { params(referral_coupon_code: String).void }
+        sig { params(referral_coupon_code: T.nilable(String)).void }
         attr_writer :referral_coupon_code
 
         sig { returns(T.nilable(String)) }
         attr_reader :referral_description
 
-        sig { params(referral_description: String).void }
+        sig { params(referral_description: T.nilable(String)).void }
         attr_writer :referral_description
 
         sig { returns(T.nilable(T::Boolean)) }
@@ -162,7 +183,10 @@ module GrowsurfRuby
         attr_reader :referred_value
 
         sig do
-          params(referred_value: GrowsurfRuby::RewardTaxValuation::OrHash).void
+          params(
+            referred_value:
+              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
         end
         attr_writer :referred_value
 
@@ -177,7 +201,11 @@ module GrowsurfRuby
         sig { returns(T.nilable(GrowsurfRuby::RewardTaxValuation)) }
         attr_reader :value
 
-        sig { params(value: GrowsurfRuby::RewardTaxValuation::OrHash).void }
+        sig do
+          params(
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash)
+          ).void
+        end
         attr_writer :value
 
         sig do
@@ -186,25 +214,28 @@ module GrowsurfRuby
             campaign_reward_id: String,
             commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
             conversions_required: Integer,
-            coupon_code: String,
+            coupon_code: T.nilable(String),
             description: String,
-            image_url: String,
+            event:
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
+            image_url: T.nilable(String),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
             limit_duration:
               GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::OrSymbol,
             metadata: T::Hash[Symbol, T.anything],
-            next_milestone_prefix: String,
-            next_milestone_suffix: String,
+            next_milestone_prefix: T.nilable(String),
+            next_milestone_suffix: T.nilable(String),
             number_of_winners: Integer,
             order: Integer,
-            referral_coupon_code: String,
-            referral_description: String,
+            referral_coupon_code: T.nilable(String),
+            referral_description: T.nilable(String),
             referred_reward_upfront: T::Boolean,
-            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            referred_value:
+              T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
             title: String,
-            value: GrowsurfRuby::RewardTaxValuation::OrHash,
+            value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -218,6 +249,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, the stored event is preserved.
+          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.
@@ -264,25 +300,28 @@ module GrowsurfRuby
               campaign_reward_id: String,
               commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
               conversions_required: Integer,
-              coupon_code: String,
+              coupon_code: T.nilable(String),
               description: String,
-              image_url: String,
+              event:
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
+              image_url: T.nilable(String),
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,
               limit_duration:
                 GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration::OrSymbol,
               metadata: T::Hash[Symbol, T.anything],
-              next_milestone_prefix: String,
-              next_milestone_suffix: String,
+              next_milestone_prefix: T.nilable(String),
+              next_milestone_suffix: T.nilable(String),
               number_of_winners: Integer,
               order: Integer,
-              referral_coupon_code: String,
-              referral_description: String,
+              referral_coupon_code: T.nilable(String),
+              referral_description: T.nilable(String),
               referred_reward_upfront: T::Boolean,
-              referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
+              referred_value:
+                T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
               title: String,
-              value: GrowsurfRuby::RewardTaxValuation::OrHash,
+              value: T.nilable(GrowsurfRuby::RewardTaxValuation::OrHash),
               request_options: GrowsurfRuby::RequestOptions
             }
           )
@@ -290,6 +329,40 @@ module GrowsurfRuby
         def to_hash
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(
+              :LEAD,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+            )
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum
 

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -41,7 +41,7 @@ module GrowsurfRuby
       sig { returns(T.nilable(String)) }
       attr_reader :currency_iso
 
-      sig { params(currency_iso: String).void }
+      sig { params(currency_iso: T.nilable(String)).void }
       attr_writer :currency_iso
 
       sig do
@@ -56,7 +56,7 @@ module GrowsurfRuby
           status: GrowsurfRuby::CampaignAPI::Status::OrSymbol,
           type: GrowsurfRuby::CampaignAPI::Type::OrSymbol,
           winner_count: Integer,
-          currency_iso: String
+          currency_iso: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -87,7 +87,7 @@ module GrowsurfRuby
             status: GrowsurfRuby::CampaignAPI::Status::TaggedSymbol,
             type: GrowsurfRuby::CampaignAPI::Type::TaggedSymbol,
             winner_count: Integer,
-            currency_iso: String
+            currency_iso: T.nilable(String)
           }
         )
       end
@@ -139,6 +139,16 @@ 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::CampaignAPI::Reward::Event::TaggedSymbol)
+          )
+        end
+        attr_accessor :event
+
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
@@ -221,6 +231,8 @@ module GrowsurfRuby
             conversions_required: T.nilable(Integer),
             coupon_code: T.nilable(String),
             description: T.nilable(String),
+            event:
+              T.nilable(GrowsurfRuby::CampaignAPI::Reward::Event::OrSymbol),
             image_url: T.nilable(String),
             limit: T.nilable(Integer),
             limit_duration:
@@ -251,6 +263,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,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
@@ -290,6 +306,10 @@ module GrowsurfRuby
               conversions_required: T.nilable(Integer),
               coupon_code: T.nilable(String),
               description: T.nilable(String),
+              event:
+                T.nilable(
+                  GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol
+                ),
               image_url: T.nilable(String),
               limit: T.nilable(Integer),
               limit_duration:
@@ -355,6 +375,32 @@ module GrowsurfRuby
           end
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::CampaignAPI::Reward::Event)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(:LEAD, GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol)
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum
 
@@ -395,10 +441,13 @@ module GrowsurfRuby
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DRAFT = T.let(:DRAFT, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+        PENDING = T.let(:PENDING, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
         IN_PROGRESS =
           T.let(:IN_PROGRESS, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
         COMPLETE =
           T.let(:COMPLETE, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+        CANCELLED =
+          T.let(:CANCELLED, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
         DELETED =
           T.let(:DELETED, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)