growsurf-ruby 0.7.0 → 1.0.0

data/lib/growsurf_ruby/resources/campaign/options.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+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 (fraud/reCAPTCHA, tax documentation,
+        # notification emails, and other program settings).
+        #
+        # This is a large, nested object. See the API reference for the full field list.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/options", id],
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a program's options configuration. Only the fields you send are changed.
+        # Unknown fields and invalid values return a `400`.
+        #
+        # The request body is a partial {CampaignOptions} object — see the API reference
+        # for the full field list.
+        #
+        # @overload update(id, body, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param body [Hash{Symbol=>Object}] Partial options configuration to merge.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def update(id, body, params = {})
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/options", id],
+            body: body,
+            model: GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign/rewards.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Rewards
+        # Retrieves the active, visible, and enabled rewards configured for a program.
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::CampaignRewardListResponse]
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["campaign/%1$s/reward-configs", id],
+            model: GrowsurfRuby::Models::Campaign::CampaignRewardListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Creates a reward for a program. The reward `type` must be compatible with the
+        # program type.
+        #
+        # @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param type [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type] Body param: The reward type. Immutable after creation.
+        #
+        # @param commission_structure [GrowsurfRuby::Models::CommissionStructure] Body param
+        #
+        # @param conversions_required [Integer] Body param
+        #
+        # @param coupon_code [String] Body param
+        #
+        # @param description [String] Body param
+        #
+        # @param image_url [String] Body param
+        #
+        # @param is_active [Boolean] Body param
+        #
+        # @param is_unlimited [Boolean] Body param
+        #
+        # @param is_visible [Boolean] Body param
+        #
+        # @param limit [Integer] Body param
+        #
+        # @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration] Body param
+        #
+        # @param metadata [Hash{Symbol=>Object}] Body param: Custom key/value metadata (single-level; values are stored as string
+        #
+        # @param next_milestone_prefix [String] Body param
+        #
+        # @param next_milestone_suffix [String] Body param
+        #
+        # @param number_of_winners [Integer] Body param
+        #
+        # @param order [Integer] Body param
+        #
+        # @param referral_coupon_code [String] Body param
+        #
+        # @param referral_description [String] Body param
+        #
+        # @param referred_reward_upfront [Boolean] Body param
+        #
+        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the referred friend's side of a double-sided rewa
+        #
+        # @param title [String] Body param
+        #
+        # @param value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the reward (the referrer's side of a double-sided
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Reward]
+        #
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams
+        def create(id, params)
+          parsed, options = GrowsurfRuby::Campaign::RewardCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/reward-configs", id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Reward,
+            options: options
+          )
+        end
+
+        # Updates an existing campaign reward. Only the fields you send are changed;
+        # `type` is immutable and must not be supplied.
+        #
+        # @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, is_active: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
+        #
+        # @param campaign_reward_id [String] Path param: Campaign reward ID.
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param commission_structure [GrowsurfRuby::Models::CommissionStructure] Body param
+        #
+        # @param conversions_required [Integer] Body param
+        #
+        # @param coupon_code [String] Body param
+        #
+        # @param description [String] Body param
+        #
+        # @param image_url [String] Body param
+        #
+        # @param is_active [Boolean] Body param
+        #
+        # @param is_unlimited [Boolean] Body param
+        #
+        # @param is_visible [Boolean] Body param
+        #
+        # @param limit [Integer] Body param
+        #
+        # @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::LimitDuration] Body param
+        #
+        # @param metadata [Hash{Symbol=>Object}] Body param: Custom key/value metadata (single-level; values are stored as string
+        #
+        # @param next_milestone_prefix [String] Body param
+        #
+        # @param next_milestone_suffix [String] Body param
+        #
+        # @param number_of_winners [Integer] Body param
+        #
+        # @param order [Integer] Body param
+        #
+        # @param referral_coupon_code [String] Body param
+        #
+        # @param referral_description [String] Body param
+        #
+        # @param referred_reward_upfront [Boolean] Body param
+        #
+        # @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the referred friend's side of a double-sided rewa
+        #
+        # @param title [String] Body param
+        #
+        # @param value [GrowsurfRuby::Models::RewardTaxValuation] Body param: Tax valuation for the reward (the referrer's side of a double-sided
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::Reward]
+        #
+        # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams
+        def update(campaign_reward_id, params)
+          parsed, options = GrowsurfRuby::Campaign::RewardUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["campaign/%1$s/reward-configs/%2$s", id, campaign_reward_id],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::Reward,
+            options: options
+          )
+        end
+
+        # Deletes a campaign reward.
+        #
+        # @overload delete(campaign_reward_id, id:, request_options: {})
+        #
+        # @param campaign_reward_id [String] Campaign reward ID.
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::DeleteRewardResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::RewardDeleteParams
+        def delete(campaign_reward_id, params)
+          parsed, options = GrowsurfRuby::Campaign::RewardDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["campaign/%1$s/reward-configs/%2$s", id, campaign_reward_id],
+            model: GrowsurfRuby::Models::Campaign::DeleteRewardResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign.rb

@@ -14,6 +14,26 @@ module GrowsurfRuby
       # @return [GrowsurfRuby::Resources::Campaign::Commission]
       attr_reader :commission
 
+      # Campaign reward configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Rewards]
+      attr_reader :rewards
+
+      # Program Editor "Design" tab configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Design]
+      attr_reader :design
+
+      # Program Editor "Emails" tab configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Emails]
+      attr_reader :emails
+
+      # Program Editor "Options" tab configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Options]
+      attr_reader :options
+
+      # Program Editor "Installation" tab configuration operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Installation]
+      attr_reader :installation
+
       # Retrieves a program for the given program ID.
       #
       # @overload retrieve(id, request_options: {})
@@ -52,6 +72,93 @@ 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
+      # (e.g. `campaign.options.update`) after the program is created.
+      #
+      # @overload create(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {})
+      #
+      # @param type [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type] The program type. Immutable after creation.
+      #
+      # @param company_logo_image_url [String]
+      #
+      # @param company_name [String]
+      #
+      # @param currency_iso [String] ISO 4217 currency code. Defaults to USD. Chosen when the program is created and immutable afterward — it cannot be changed on update.
+      #
+      # @param name [String] The program name. Defaults to "Untitled Program".
+      #
+      # @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>] Optional inline rewards to create with the program.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignAPI]
+      #
+      # @see GrowsurfRuby::Models::CampaignCreateParams
+      def create(params)
+        parsed, options = GrowsurfRuby::CampaignCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "campaigns",
+          body: parsed,
+          model: GrowsurfRuby::CampaignAPI,
+          options: 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
+      # (`campaign.design`, `campaign.emails`, `campaign.options`, `campaign.installation`),
+      # not here.
+      #
+      # @overload update(id, company_logo_image_url: nil, company_name: nil, name: nil, status: nil, request_options: {})
+      #
+      # @param id [String] Path param: GrowSurf program ID.
+      #
+      # @param company_logo_image_url [String] Body param
+      #
+      # @param company_name [String] Body param
+      #
+      # @param name [String] Body param
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignUpdateParams::Status] Body param: The program status. Transitions are validated; DELETED is not allowe
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignAPI]
+      #
+      # @see GrowsurfRuby::Models::CampaignUpdateParams
+      def update(id, params)
+        parsed, options = GrowsurfRuby::CampaignUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["campaign/%1$s", id],
+          body: parsed,
+          model: GrowsurfRuby::CampaignAPI,
+          options: options
+        )
+      end
+
+      # Clones an existing program, returning the newly created program.
+      #
+      # @overload clone(id, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignAPI]
+      def clone(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["campaign/%1$s/clone", id],
+          model: GrowsurfRuby::CampaignAPI,
+          options: params[:request_options]
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams} for more
       # details.
@@ -307,6 +414,11 @@ module GrowsurfRuby
         @participant = GrowsurfRuby::Resources::Campaign::Participant.new(client: client)
         @reward = GrowsurfRuby::Resources::Campaign::Reward.new(client: client)
         @commission = GrowsurfRuby::Resources::Campaign::Commission.new(client: client)
+        @rewards = GrowsurfRuby::Resources::Campaign::Rewards.new(client: client)
+        @design = GrowsurfRuby::Resources::Campaign::Design.new(client: client)
+        @emails = GrowsurfRuby::Resources::Campaign::Emails.new(client: client)
+        @options = GrowsurfRuby::Resources::Campaign::Options.new(client: client)
+        @installation = GrowsurfRuby::Resources::Campaign::Installation.new(client: client)
       end
     end
   end

data/lib/growsurf_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrowsurfRuby
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/lib/growsurf_ruby.rb

@@ -54,10 +54,12 @@ require_relative "growsurf_ruby/internal/transport/pooled_net_requester"
 require_relative "growsurf_ruby/client"
 require_relative "growsurf_ruby/models/campaign/create"
 require_relative "growsurf_ruby/models/campaign/participant"
+require_relative "growsurf_ruby/models/campaign/campaign_reward_list_response"
 require_relative "growsurf_ruby/models/campaign/commission_approve_params"
 require_relative "growsurf_ruby/models/campaign/commission_approve_response"
 require_relative "growsurf_ruby/models/campaign/commission_delete_params"
 require_relative "growsurf_ruby/models/campaign/commission_delete_response"
+require_relative "growsurf_ruby/models/campaign/delete_reward_response"
 require_relative "growsurf_ruby/models/campaign/fraud_risk_level"
 require_relative "growsurf_ruby/models/campaign/participant_add_params"
 require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params"
@@ -82,15 +84,19 @@ require_relative "growsurf_ruby/models/campaign/participant_trigger_referral_res
 require_relative "growsurf_ruby/models/campaign/participant_update_params"
 require_relative "growsurf_ruby/models/campaign/referral_source"
 require_relative "growsurf_ruby/models/campaign/referral_status"
+require_relative "growsurf_ruby/models/campaign/reward"
 require_relative "growsurf_ruby/models/campaign/reward_approve_params"
 require_relative "growsurf_ruby/models/campaign/reward_approve_response"
+require_relative "growsurf_ruby/models/campaign/reward_create_params"
 require_relative "growsurf_ruby/models/campaign/reward_delete_params"
 require_relative "growsurf_ruby/models/campaign/reward_delete_response"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_params"
 require_relative "growsurf_ruby/models/campaign/reward_fulfill_response"
+require_relative "growsurf_ruby/models/campaign/reward_update_params"
 require_relative "growsurf_ruby/models/campaign"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_params"
 require_relative "growsurf_ruby/models/campaign_create_mobile_participant_token_response"
+require_relative "growsurf_ruby/models/campaign_create_params"
 require_relative "growsurf_ruby/models/campaign_list_commissions_params"
 require_relative "growsurf_ruby/models/campaign_list_leaderboard_params"
 require_relative "growsurf_ruby/models/campaign_list_params"
@@ -101,13 +107,20 @@ require_relative "growsurf_ruby/models/campaign_list_response"
 require_relative "growsurf_ruby/models/campaign_retrieve_analytics_params"
 require_relative "growsurf_ruby/models/campaign_retrieve_analytics_response"
 require_relative "growsurf_ruby/models/campaign_retrieve_params"
+require_relative "growsurf_ruby/models/campaign_update_params"
 require_relative "growsurf_ruby/models/commission_structure"
 require_relative "growsurf_ruby/models/participant_commission_list"
 require_relative "growsurf_ruby/models/participant_list"
 require_relative "growsurf_ruby/models/participant_payout_list"
 require_relative "growsurf_ruby/models/referral_list"
+require_relative "growsurf_ruby/models/reward_tax_valuation"
 require_relative "growsurf_ruby/models"
 require_relative "growsurf_ruby/resources/campaign"
 require_relative "growsurf_ruby/resources/campaign/commission"
+require_relative "growsurf_ruby/resources/campaign/design"
+require_relative "growsurf_ruby/resources/campaign/emails"
+require_relative "growsurf_ruby/resources/campaign/installation"
+require_relative "growsurf_ruby/resources/campaign/options"
 require_relative "growsurf_ruby/resources/campaign/participant"
 require_relative "growsurf_ruby/resources/campaign/reward"
+require_relative "growsurf_ruby/resources/campaign/rewards"

data/rbi/growsurf_ruby/models/campaign/campaign_reward_list_response.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::CampaignRewardListResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # The program's active, visible, and enabled rewards.
+        sig { returns(T::Array[GrowsurfRuby::Models::Campaign::Reward]) }
+        attr_accessor :rewards
+
+        # The list of a program's configured rewards.
+        sig do
+          params(
+            rewards: T::Array[GrowsurfRuby::Models::Campaign::Reward::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The program's active, visible, and enabled rewards.
+          rewards:
+        )
+        end
+
+        sig do
+          override.returns(
+            { rewards: T::Array[GrowsurfRuby::Models::Campaign::Reward] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/delete_reward_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class DeleteRewardResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::DeleteRewardResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # The deleted reward ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig do
+          params(id: String, success: T::Boolean).returns(T.attached_class)
+        end
+        def self.new(
+          # The deleted reward ID.
+          id:,
+          success:
+        )
+        end
+
+        sig { override.returns({ id: String, success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end