growsurf-ruby 1.14.0 → 1.15.0

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

@@ -80,6 +80,29 @@ module GrowsurfRuby
         sig { params(image_url: T.nilable(String)).void }
         attr_writer :image_url
 
+        # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+        # image. Participant pages draw this icon in your program's accent color. Also set
+        # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+        # `imageUrl` without `imageIconKey` clears it.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
+            )
+          )
+        end
+        attr_reader :image_icon_key
+
+        sig do
+          params(
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
+              )
+          ).void
+        end
+        attr_writer :image_icon_key
+
         # Whether the reward can be earned an unlimited number of times. Defaults to
         # `true`, except `MILESTONE` rewards, which can only be earned once.
         sig { returns(T.nilable(T::Boolean)) }
@@ -220,6 +243,10 @@ module GrowsurfRuby
             event:
               GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
             image_url: T.nilable(String),
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
+              ),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -255,6 +282,11 @@ module GrowsurfRuby
           # `MILESTONE` rewards. When omitted, it defaults to `CONVERSION`.
           event: nil,
           image_url: nil,
+          # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+          # image. Participant pages draw this icon in your program's accent color. Also set
+          # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+          # `imageUrl` without `imageIconKey` clears it.
+          image_icon_key: nil,
           # Whether the reward can be earned an unlimited number of times. Defaults to
           # `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
@@ -305,6 +337,10 @@ module GrowsurfRuby
               event:
                 GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
               image_url: T.nilable(String),
+              image_icon_key:
+                T.nilable(
+                  GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
+                ),
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,
@@ -450,6 +486,140 @@ module GrowsurfRuby
           def self.values
           end
         end
+
+        module ImageIconKey
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GIFT_1 =
+            T.let(
+              :GIFT_1,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_2 =
+            T.let(
+              :GIFT_2,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_3 =
+            T.let(
+              :GIFT_3,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_4 =
+            T.let(
+              :GIFT_4,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_5 =
+            T.let(
+              :GIFT_5,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_6 =
+            T.let(
+              :GIFT_6,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_CARD =
+            T.let(
+              :GIFT_CARD,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          CASH =
+            T.let(
+              :CASH,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          COIN =
+            T.let(
+              :COIN,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          CARD =
+            T.let(
+              :CARD,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_1 =
+            T.let(
+              :STAR_1,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_2 =
+            T.let(
+              :STAR_2,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_3 =
+            T.let(
+              :STAR_3,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          TROPHY =
+            T.let(
+              :TROPHY,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          CROWN =
+            T.let(
+              :CROWN,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          SEAL =
+            T.let(
+              :SEAL,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          HEART_1 =
+            T.let(
+              :HEART_1,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          HEART_2 =
+            T.let(
+              :HEART_2,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          TAG =
+            T.let(
+              :TAG,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          DIAMOND =
+            T.let(
+              :DIAMOND,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          CONFETTI =
+            T.let(
+              :CONFETTI,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+          ROCKET =
+            T.let(
+              :ROCKET,
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

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

@@ -79,6 +79,29 @@ module GrowsurfRuby
         sig { params(image_url: T.nilable(String)).void }
         attr_writer :image_url
 
+        # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+        # image. Participant pages draw this icon in your program's accent color. Also set
+        # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+        # `imageUrl` without `imageIconKey` clears it.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
+            )
+          )
+        end
+        attr_reader :image_icon_key
+
+        sig do
+          params(
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
+              )
+          ).void
+        end
+        attr_writer :image_icon_key
+
         # Whether the reward can be earned an unlimited number of times. Defaults to
         # `true`, except `MILESTONE` rewards, which can only be earned once.
         sig { returns(T.nilable(T::Boolean)) }
@@ -219,6 +242,10 @@ module GrowsurfRuby
             event:
               GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
             image_url: T.nilable(String),
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
+              ),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -255,6 +282,11 @@ module GrowsurfRuby
           # `MILESTONE` rewards. When omitted, the stored event is preserved.
           event: nil,
           image_url: nil,
+          # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+          # image. Participant pages draw this icon in your program's accent color. Also set
+          # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
+          # `imageUrl` without `imageIconKey` clears it.
+          image_icon_key: nil,
           # Whether the reward can be earned an unlimited number of times. Defaults to
           # `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
@@ -305,6 +337,10 @@ module GrowsurfRuby
               event:
                 GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
               image_url: T.nilable(String),
+              image_icon_key:
+                T.nilable(
+                  GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
+                ),
               is_unlimited: T::Boolean,
               is_visible: T::Boolean,
               limit: Integer,
@@ -401,6 +437,140 @@ module GrowsurfRuby
           def self.values
           end
         end
+
+        module ImageIconKey
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GIFT_1 =
+            T.let(
+              :GIFT_1,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_2 =
+            T.let(
+              :GIFT_2,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_3 =
+            T.let(
+              :GIFT_3,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_4 =
+            T.let(
+              :GIFT_4,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_5 =
+            T.let(
+              :GIFT_5,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_6 =
+            T.let(
+              :GIFT_6,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          GIFT_CARD =
+            T.let(
+              :GIFT_CARD,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          CASH =
+            T.let(
+              :CASH,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          COIN =
+            T.let(
+              :COIN,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          CARD =
+            T.let(
+              :CARD,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_1 =
+            T.let(
+              :STAR_1,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_2 =
+            T.let(
+              :STAR_2,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          STAR_3 =
+            T.let(
+              :STAR_3,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          TROPHY =
+            T.let(
+              :TROPHY,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          CROWN =
+            T.let(
+              :CROWN,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          SEAL =
+            T.let(
+              :SEAL,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          HEART_1 =
+            T.let(
+              :HEART_1,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          HEART_2 =
+            T.let(
+              :HEART_2,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          TAG =
+            T.let(
+              :TAG,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          DIAMOND =
+            T.let(
+              :DIAMOND,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          CONFETTI =
+            T.let(
+              :CONFETTI,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+          ROCKET =
+            T.let(
+              :ROCKET,
+              GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -152,6 +152,17 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
+        # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+        # image.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :image_icon_key
+
         # `-1` represents an unlimited reward in REST responses.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :limit
@@ -234,6 +245,10 @@ module GrowsurfRuby
             event:
               T.nilable(GrowsurfRuby::CampaignAPI::Reward::Event::OrSymbol),
             image_url: T.nilable(String),
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::OrSymbol
+              ),
             limit: T.nilable(Integer),
             limit_duration:
               T.nilable(
@@ -268,6 +283,9 @@ module GrowsurfRuby
           # Rewards return `CONVERSION`.
           event: nil,
           image_url: nil,
+          # The starter icon shown for the reward, or `null` when `imageUrl` is your own
+          # image.
+          image_icon_key: nil,
           # `-1` represents an unlimited reward in REST responses.
           limit: nil,
           limit_duration: nil,
@@ -311,6 +329,10 @@ module GrowsurfRuby
                   GrowsurfRuby::CampaignAPI::Reward::Event::TaggedSymbol
                 ),
               image_url: T.nilable(String),
+              image_icon_key:
+                T.nilable(
+                  GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+                ),
               limit: T.nilable(Integer),
               limit_duration:
                 T.nilable(
@@ -431,6 +453,140 @@ module GrowsurfRuby
           def self.values
           end
         end
+
+        module ImageIconKey
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::CampaignAPI::Reward::ImageIconKey
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GIFT_1 =
+            T.let(
+              :GIFT_1,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_2 =
+            T.let(
+              :GIFT_2,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_3 =
+            T.let(
+              :GIFT_3,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_4 =
+            T.let(
+              :GIFT_4,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_5 =
+            T.let(
+              :GIFT_5,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_6 =
+            T.let(
+              :GIFT_6,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          GIFT_CARD =
+            T.let(
+              :GIFT_CARD,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          CASH =
+            T.let(
+              :CASH,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          COIN =
+            T.let(
+              :COIN,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          CARD =
+            T.let(
+              :CARD,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          STAR_1 =
+            T.let(
+              :STAR_1,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          STAR_2 =
+            T.let(
+              :STAR_2,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          STAR_3 =
+            T.let(
+              :STAR_3,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          TROPHY =
+            T.let(
+              :TROPHY,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          CROWN =
+            T.let(
+              :CROWN,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          SEAL =
+            T.let(
+              :SEAL,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          HEART_1 =
+            T.let(
+              :HEART_1,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          HEART_2 =
+            T.let(
+              :HEART_2,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          TAG =
+            T.let(
+              :TAG,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          DIAMOND =
+            T.let(
+              :DIAMOND,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          CONFETTI =
+            T.let(
+              :CONFETTI,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+          ROCKET =
+            T.let(
+              :ROCKET,
+              GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::CampaignAPI::Reward::ImageIconKey::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       module Status

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -82,7 +82,7 @@ module GrowsurfRuby
         )
         end
 
-        # Removes a participant by GrowSurf participant ID or email address.
+        # Removes participant access immediately by GrowSurf participant ID or email address. Related record cleanup completes automatically. Do not repeat a successful deletion to finish cleanup.
         sig do
           params(
             participant_id_or_email: String,
@@ -103,9 +103,7 @@ module GrowsurfRuby
         # `participants` is a GrowSurf participant ID or an email address (mixed lists are
         # allowed). Up to `200` entries per request — chunk larger lists across multiple
         # calls. The response reports a per-row `status` for every submitted entry, so a
-        # `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent
-        # and removes the participants' referrals, rewards, commissions, and payout
-        # records.
+        # `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention.
         sig do
           params(
             id: String,

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

@@ -40,6 +40,10 @@ module GrowsurfRuby
             event:
               GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
             image_url: T.nilable(String),
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
+              ),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -83,6 +87,11 @@ module GrowsurfRuby
           event: nil,
           # Body param
           image_url: nil,
+          # Body param: The starter icon shown for the reward, or `null` when `imageUrl` is
+          # your own image. Participant pages draw this icon in your program's accent color.
+          # Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it.
+          # Sending `imageUrl` without `imageIconKey` clears it.
+          image_icon_key: nil,
           # Body param: Whether the reward can be earned an unlimited number of times.
           # Defaults to `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,
@@ -150,6 +159,10 @@ module GrowsurfRuby
             event:
               GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
             image_url: T.nilable(String),
+            image_icon_key:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
+              ),
             is_unlimited: T::Boolean,
             is_visible: T::Boolean,
             limit: Integer,
@@ -192,6 +205,11 @@ module GrowsurfRuby
           event: nil,
           # Body param
           image_url: nil,
+          # Body param: The starter icon shown for the reward, or `null` when `imageUrl` is
+          # your own image. Participant pages draw this icon in your program's accent color.
+          # Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it.
+          # Sending `imageUrl` without `imageIconKey` clears it.
+          image_icon_key: nil,
           # Body param: Whether the reward can be earned an unlimited number of times.
           # Defaults to `true`, except `MILESTONE` rewards, which can only be earned once.
           is_unlimited: nil,