growsurf-ruby 0.8.0 → 1.0.0

data/rbi/growsurf_ruby/models/campaign_create_params.rbi

@@ -35,24 +35,12 @@ module GrowsurfRuby
       sig { params(currency_iso: String).void }
       attr_writer :currency_iso
 
-      sig { returns(T.nilable(String)) }
-      attr_reader :goal
-
-      sig { params(goal: String).void }
-      attr_writer :goal
-
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
       sig { params(name: String).void }
       attr_writer :name
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :options
-
-      sig { params(options: T::Hash[Symbol, T.anything]).void }
-      attr_writer :options
-
       sig do
         returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardCreateParams]))
       end
@@ -71,9 +59,7 @@ module GrowsurfRuby
           company_logo_image_url: String,
           company_name: String,
           currency_iso: String,
-          goal: String,
           name: String,
-          options: T::Hash[Symbol, T.anything],
           rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -83,9 +69,7 @@ module GrowsurfRuby
         company_logo_image_url: nil,
         company_name: nil,
         currency_iso: nil,
-        goal: nil,
         name: nil,
-        options: nil,
         rewards: nil,
         request_options: {}
       )
@@ -98,9 +82,7 @@ module GrowsurfRuby
             company_logo_image_url: String,
             company_name: String,
             currency_iso: String,
-            goal: String,
             name: String,
-            options: T::Hash[Symbol, T.anything],
             rewards:
               T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
             request_options: GrowsurfRuby::RequestOptions

data/rbi/growsurf_ruby/models/campaign_update_params.rbi

@@ -29,54 +29,12 @@ module GrowsurfRuby
       sig { params(company_name: String).void }
       attr_writer :company_name
 
-      sig { returns(T.nilable(String)) }
-      attr_reader :currency_iso
-
-      sig { params(currency_iso: String).void }
-      attr_writer :currency_iso
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :design
-
-      sig { params(design: T::Hash[Symbol, T.anything]).void }
-      attr_writer :design
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :emails
-
-      sig { params(emails: T::Hash[Symbol, T.anything]).void }
-      attr_writer :emails
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :goal
-
-      sig { params(goal: String).void }
-      attr_writer :goal
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :installation
-
-      sig { params(installation: T::Hash[Symbol, T.anything]).void }
-      attr_writer :installation
-
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
       sig { params(name: String).void }
       attr_writer :name
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :notifications
-
-      sig { params(notifications: T::Hash[Symbol, T.anything]).void }
-      attr_writer :notifications
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_reader :options
-
-      sig { params(options: T::Hash[Symbol, T.anything]).void }
-      attr_writer :options
-
       sig do
         returns(T.nilable(GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol))
       end
@@ -94,14 +52,7 @@ module GrowsurfRuby
           id: String,
           company_logo_image_url: String,
           company_name: String,
-          currency_iso: String,
-          design: T::Hash[Symbol, T.anything],
-          emails: T::Hash[Symbol, T.anything],
-          goal: String,
-          installation: T::Hash[Symbol, T.anything],
           name: String,
-          notifications: T::Hash[Symbol, T.anything],
-          options: T::Hash[Symbol, T.anything],
           status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -110,14 +61,7 @@ module GrowsurfRuby
         id:,
         company_logo_image_url: nil,
         company_name: nil,
-        currency_iso: nil,
-        design: nil,
-        emails: nil,
-        goal: nil,
-        installation: nil,
         name: nil,
-        notifications: nil,
-        options: nil,
         status: nil,
         request_options: {}
       )
@@ -129,14 +73,7 @@ module GrowsurfRuby
             id: String,
             company_logo_image_url: String,
             company_name: String,
-            currency_iso: String,
-            design: T::Hash[Symbol, T.anything],
-            emails: T::Hash[Symbol, T.anything],
-            goal: String,
-            installation: T::Hash[Symbol, T.anything],
             name: String,
-            notifications: T::Hash[Symbol, T.anything],
-            options: T::Hash[Symbol, T.anything],
             status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
             request_options: GrowsurfRuby::RequestOptions
           }

data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    # Tax valuation settings for a reward. Only relevant when the program collects
+    # tax documentation.
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::RewardTaxValuation,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # Manual fair-market value in USD (major units) used as the fallback when the
+      # reward value cannot be resolved automatically. `null` = no manual value.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fair_market_value_usd
+
+      # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+      # the smart default for the reward's source.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_tax_reportable
+
+      # Tax valuation settings for a reward. Only relevant when the program collects
+      # tax documentation.
+      sig do
+        params(
+          fair_market_value_usd: T.nilable(Float),
+          is_tax_reportable: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Manual fair-market value in USD (major units) used as the fallback when the
+        # reward value cannot be resolved automatically. `null` = no manual value.
+        fair_market_value_usd: nil,
+        # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
+        # the smart default for the reward's source.
+        is_tax_reportable: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            fair_market_value_usd: T.nilable(Float),
+            is_tax_reportable: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -42,4 +42,6 @@ module GrowsurfRuby
   ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
 
   ReferralList = GrowsurfRuby::Models::ReferralList
+
+  RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/rbi/growsurf_ruby/resources/campaign/design.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Design
+        # Retrieves a program's design configuration — the same surface as the dashboard
+        # Program Editor's **Design** tab. This is a large, deeply nested object whose
+        # available fields depend on the program type. See the API reference for the full
+        # field list.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's design configuration. Only the fields you send are changed.
+        # The request body is a partial design object — see the API reference for the full
+        # field list.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial design configuration to merge.
+          body,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/emails.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Emails
+        # Retrieves a program's email configuration — the same surface as the dashboard
+        # Program Editor's **Emails** tab. This is a large, nested object. See the API
+        # reference for the full field list.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's email configuration. Only the fields you send are changed.
+        # The request body is a partial email configuration object — see the API reference
+        # for the full field list.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial email configuration to merge.
+          body,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/installation.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Installation
+        # Retrieves a program's installation configuration — the same surface as the
+        # dashboard Program Editor's **Installation** tab. This is a nested object whose
+        # available fields depend on the program type. See the API reference for the full
+        # field list.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's installation configuration. Only the fields you send are
+        # changed. The request body is a partial installation configuration object — see
+        # the API reference for the full field list.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial installation configuration to merge.
+          body,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/options.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Options
+        # Retrieves a program's options configuration — the same surface as the dashboard
+        # Program Editor's **Options** tab. This is a large, nested object. See the API
+        # reference for the full field list.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def retrieve(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates a program's options configuration. Only the fields you send are changed.
+        # The request body is a partial options configuration object — see the API
+        # reference for the full field list.
+        sig do
+          params(
+            id: String,
+            body: T::Hash[Symbol, T.anything],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T::Hash[Symbol, T.anything])
+        end
+        def update(
+          # GrowSurf program ID.
+          id,
+          # Partial options configuration to merge.
+          body,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

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

@@ -44,7 +44,9 @@ module GrowsurfRuby
             referral_coupon_code: String,
             referral_description: String,
             referred_reward_upfront: T::Boolean,
+            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
             title: String,
+            value: GrowsurfRuby::RewardTaxValuation::OrHash,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(GrowsurfRuby::Models::Campaign::Reward)
         end
@@ -90,17 +92,23 @@ module GrowsurfRuby
           referral_description: nil,
           # Body param
           referred_reward_upfront: nil,
+          # Body param: Tax valuation for the referred friend's side of a double-sided
+          # reward. Defaults to not tax-reportable (a purchase rebate).
+          referred_value: nil,
           # Body param
           title: nil,
+          # Body param: Tax valuation for the reward (the referrer's side of a
+          # double-sided reward). Used by tax documentation / 1099 reporting.
+          value: nil,
           request_options: {}
         )
         end
 
-        # Updates an existing program reward. Only the fields you send are changed; `type`
+        # Updates an existing campaign reward. Only the fields you send are changed; `type`
         # is immutable and must not be supplied.
         sig do
           params(
-            reward_id: String,
+            campaign_reward_id: String,
             id: String,
             commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
             conversions_required: Integer,
@@ -121,13 +129,15 @@ module GrowsurfRuby
             referral_coupon_code: String,
             referral_description: String,
             referred_reward_upfront: T::Boolean,
+            referred_value: GrowsurfRuby::RewardTaxValuation::OrHash,
             title: String,
+            value: GrowsurfRuby::RewardTaxValuation::OrHash,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(GrowsurfRuby::Models::Campaign::Reward)
         end
         def update(
-          # Path param: Program reward ID.
-          reward_id,
+          # Path param: Campaign reward ID.
+          campaign_reward_id,
           # Path param: GrowSurf program ID.
           id:,
           # Body param
@@ -167,23 +177,29 @@ module GrowsurfRuby
           referral_description: nil,
           # Body param
           referred_reward_upfront: nil,
+          # Body param: Tax valuation for the referred friend's side of a double-sided
+          # reward. Defaults to not tax-reportable (a purchase rebate).
+          referred_value: nil,
           # Body param
           title: nil,
+          # Body param: Tax valuation for the reward (the referrer's side of a
+          # double-sided reward). Used by tax documentation / 1099 reporting.
+          value: nil,
           request_options: {}
         )
         end
 
-        # Deletes a program reward.
+        # Deletes a campaign reward.
         sig do
           params(
-            reward_id: String,
+            campaign_reward_id: String,
             id: String,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(GrowsurfRuby::Models::Campaign::DeleteRewardResponse)
         end
         def delete(
-          # Program reward ID.
-          reward_id,
+          # Campaign reward ID.
+          campaign_reward_id,
           # GrowSurf program ID.
           id:,
           request_options: {}

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -14,10 +14,26 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
       attr_reader :commission
 
-      # Program reward configuration operations.
+      # Campaign reward configuration operations.
       sig { returns(GrowsurfRuby::Resources::Campaign::Rewards) }
       attr_reader :rewards
 
+      # Program Editor "Design" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Design) }
+      attr_reader :design
+
+      # Program Editor "Emails" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Emails) }
+      attr_reader :emails
+
+      # Program Editor "Options" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Options) }
+      attr_reader :options
+
+      # Program Editor "Installation" tab configuration operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Installation) }
+      attr_reader :installation
+
       # Retrieves a program for the given program ID.
       sig do
         params(
@@ -42,15 +58,15 @@ module GrowsurfRuby
       end
 
       # Creates a program. Only `type` is required; everything else is server-defaulted.
+      # Editor-tab configuration (design, emails, options, installation) is not accepted
+      # here — configure it via the config sub-resources after the program is created.
       sig do
         params(
           type: GrowsurfRuby::CampaignCreateParams::Type::OrSymbol,
           company_logo_image_url: String,
           company_name: String,
           currency_iso: String,
-          goal: String,
           name: String,
-          options: T::Hash[Symbol, T.anything],
           rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(GrowsurfRuby::CampaignAPI)
@@ -60,34 +76,27 @@ module GrowsurfRuby
         type:,
         company_logo_image_url: nil,
         company_name: nil,
-        # ISO 4217 currency code. Defaults to USD.
+        # ISO 4217 currency code. Defaults to USD. Chosen when the program is created and
+        # immutable afterward — it cannot be changed on update.
         currency_iso: nil,
-        goal: nil,
         # The program name. Defaults to "Untitled Program".
         name: nil,
-        # A curated subset of program options to shallow-merge onto the defaults.
-        options: nil,
         # Optional inline rewards to create with the program.
         rewards: nil,
         request_options: {}
       )
       end
 
-      # Updates a program. Only the fields you send are changed. `type` and `urlId` are
-      # immutable.
+      # Updates a program's identity and lifecycle. Only the fields you send are changed.
+      # `type`, `urlId`, and `currencyISO` are immutable. Editor-tab configuration (design, emails,
+      # options, installation) is edited via the dedicated config sub-resources, not
+      # here.
       sig do
         params(
           id: String,
           company_logo_image_url: String,
           company_name: String,
-          currency_iso: String,
-          design: T::Hash[Symbol, T.anything],
-          emails: T::Hash[Symbol, T.anything],
-          goal: String,
-          installation: T::Hash[Symbol, T.anything],
           name: String,
-          notifications: T::Hash[Symbol, T.anything],
-          options: T::Hash[Symbol, T.anything],
           status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(GrowsurfRuby::CampaignAPI)
@@ -100,21 +109,7 @@ module GrowsurfRuby
         # Body param
         company_name: nil,
         # Body param
-        currency_iso: nil,
-        # Body param
-        design: nil,
-        # Body param
-        emails: nil,
-        # Body param
-        goal: nil,
-        # Body param
-        installation: nil,
-        # Body param
         name: nil,
-        # Body param
-        notifications: nil,
-        # Body param
-        options: nil,
         # Body param: The program status. Transitions are validated; DELETED is not
         # allowed.
         status: nil,

data/sig/growsurf_ruby/models/campaign/reward.rbs

@@ -18,8 +18,11 @@ module GrowsurfRuby
           next_milestone_suffix: String?,
           number_of_winners: Integer?,
           order: Integer?,
+          referral_coupon_code: String?,
           referral_description: String?,
-          referred_reward_upfront: bool
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
         }
 
       class Reward < GrowsurfRuby::Internal::Type::BaseModel
@@ -53,12 +56,18 @@ module GrowsurfRuby
 
         attr_accessor order: Integer?
 
+        attr_accessor referral_coupon_code: String?
+
         attr_accessor referral_description: String?
 
         attr_reader referred_reward_upfront: bool?
 
         def referred_reward_upfront=: (bool) -> bool
 
+        attr_accessor referred_value: GrowsurfRuby::RewardTaxValuation?
+
+        attr_accessor value: GrowsurfRuby::RewardTaxValuation?
+
         def initialize: (
           id: String,
           is_unlimited: bool,
@@ -75,8 +84,11 @@ module GrowsurfRuby
           ?next_milestone_suffix: String?,
           ?number_of_winners: Integer?,
           ?order: Integer?,
+          ?referral_coupon_code: String?,
           ?referral_description: String?,
-          ?referred_reward_upfront: bool
+          ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation?,
+          ?value: GrowsurfRuby::RewardTaxValuation?
         ) -> void
 
         def to_hash: -> {
@@ -95,8 +107,11 @@ module GrowsurfRuby
           next_milestone_suffix: String?,
           number_of_winners: Integer?,
           order: Integer?,
+          referral_coupon_code: String?,
           referral_description: String?,
-          referred_reward_upfront: bool
+          referred_reward_upfront: bool,
+          referred_value: GrowsurfRuby::RewardTaxValuation?,
+          value: GrowsurfRuby::RewardTaxValuation?
         }
 
         type type_ =