growsurf-ruby 0.7.0 → 1.0.0

data/rbi/growsurf_ruby/models.rbi

@@ -8,6 +8,8 @@ module GrowsurfRuby
   CampaignCreateMobileParticipantTokenParams =
     GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
+  CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
+
   CampaignListCommissionsParams =
     GrowsurfRuby::Models::CampaignListCommissionsParams
 
@@ -29,6 +31,8 @@ module GrowsurfRuby
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
+
   CommissionStructure = GrowsurfRuby::Models::CommissionStructure
 
   ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList
@@ -38,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

@@ -0,0 +1,216 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Rewards
+        # Retrieves the active, visible, and enabled rewards configured for a program.
+        sig do
+          params(
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::CampaignRewardListResponse)
+        end
+        def list(
+          # GrowSurf program ID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Creates a reward for a program. The reward `type` must be compatible with the
+        # program type.
+        sig do
+          params(
+            id: String,
+            type:
+              GrowsurfRuby::Models::Campaign::RewardCreateParams::Type::OrSymbol,
+            commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
+            conversions_required: Integer,
+            coupon_code: String,
+            description: String,
+            image_url: String,
+            is_active: T::Boolean,
+            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,
+            number_of_winners: Integer,
+            order: Integer,
+            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 create(
+          # Path param: GrowSurf program ID.
+          id,
+          # Body param: The reward type. Immutable after creation.
+          type:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          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 campaign reward. Only the fields you send are changed; `type`
+        # is immutable and must not be supplied.
+        sig do
+          params(
+            campaign_reward_id: String,
+            id: String,
+            commission_structure: GrowsurfRuby::CommissionStructure::OrHash,
+            conversions_required: Integer,
+            coupon_code: String,
+            description: String,
+            image_url: String,
+            is_active: T::Boolean,
+            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,
+            number_of_winners: Integer,
+            order: Integer,
+            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: Campaign reward ID.
+          campaign_reward_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          commission_structure: nil,
+          # Body param
+          conversions_required: nil,
+          # Body param
+          coupon_code: nil,
+          # Body param
+          description: nil,
+          # Body param
+          image_url: nil,
+          # Body param
+          is_active: nil,
+          # Body param
+          is_unlimited: nil,
+          # Body param
+          is_visible: nil,
+          # Body param
+          limit: nil,
+          # Body param
+          limit_duration: nil,
+          # Body param: Custom key/value metadata (single-level; values are stored as
+          # strings).
+          metadata: nil,
+          # Body param
+          next_milestone_prefix: nil,
+          # Body param
+          next_milestone_suffix: nil,
+          # Body param
+          number_of_winners: nil,
+          # Body param
+          order: nil,
+          # Body param
+          referral_coupon_code: nil,
+          # Body param
+          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 campaign reward.
+        sig do
+          params(
+            campaign_reward_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::DeleteRewardResponse)
+        end
+        def delete(
+          # Campaign reward ID.
+          campaign_reward_id,
+          # GrowSurf program ID.
+          id:,
+          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.rbi

@@ -14,6 +14,26 @@ module GrowsurfRuby
       sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
       attr_reader :commission
 
+      # 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(
@@ -37,6 +57,80 @@ module GrowsurfRuby
       def list(request_options: {})
       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,
+          name: String,
+          rewards: T::Array[GrowsurfRuby::Campaign::RewardCreateParams::OrHash],
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def create(
+        # The program type. Immutable after creation.
+        type:,
+        company_logo_image_url: nil,
+        company_name: nil,
+        # 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,
+        # The program name. Defaults to "Untitled Program".
+        name: nil,
+        # Optional inline rewards to create with the program.
+        rewards: nil,
+        request_options: {}
+      )
+      end
+
+      # 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,
+          name: String,
+          status: GrowsurfRuby::CampaignUpdateParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def update(
+        # Path param: GrowSurf program ID.
+        id,
+        # Body param
+        company_logo_image_url: nil,
+        # Body param
+        company_name: nil,
+        # Body param
+        name: nil,
+        # Body param: The program status. Transitions are validated; DELETED is not
+        # allowed.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Clones an existing program, returning the newly created program.
+      sig do
+        params(
+          id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def clone(
+        # GrowSurf program ID.
+        id,
+        request_options: {}
+      )
+      end
+
       # Creates or returns a participant using the same input behavior as Add
       # Participant, then returns a participant-scoped token for GrowSurf mobile SDK
       # participant endpoints. Use this endpoint from your backend after your mobile app

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

@@ -0,0 +1,18 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type campaign_reward_list_response =
+        { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+
+      class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+
+        def initialize: (
+          rewards: ::Array[GrowsurfRuby::Campaign::Reward]
+        ) -> void
+
+        def to_hash: -> { rewards: ::Array[GrowsurfRuby::Campaign::Reward] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type delete_reward_response = { id: String, success: bool }
+
+      class DeleteRewardResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor success: bool
+
+        def initialize: (id: String, success: bool) -> void
+
+        def to_hash: -> { id: String, success: bool }
+      end
+    end
+  end
+end