growsurf-ruby 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be12c4785ae7a40c39c8e74aeeddcc53359c12bdad594d2578b7da9e1bc1b20d
-  data.tar.gz: cb49bb681ce1bd2291b3468df5b2186f23ea41d0262210a963652934689aa956
+  metadata.gz: 3f01d0f2cb2534783b61dc721b1fde1d8f4465951558a08e474a2c0816b55785
+  data.tar.gz: bc309ac0246f6ee795ccb48487c37f366c3e04293cdc9f3fea0ef55c8a8576e0
 SHA512:
-  metadata.gz: d3b33af554e8fac71c6c3e4df21a5565c188fee651fe4d316f6c0486c0349c460bb737e2a96c852bd8856aa01e469bbf3c65c5314617b5a800423f9558e3fa70
-  data.tar.gz: db54fe7cfff4279d0af2d57589aa66106a2e0b83ce59c5a37fe6809145cca0edc59a0b3dab2a0a51c93592a1016b55564469ff05a6934ec0973ad206c5f35ffe
+  metadata.gz: bf7d990bbf244492889bdb83c07478bee329598a80eaf4bb48a9445fb322fcdd10fa1a7854a19c8f5dee29f4277d7a3a13c557f5329ebada1309ba7f7a299461
+  data.tar.gz: 4157fc3ebf661d9a92f4713b9f10d91f1f31f6d298449684c5f01946c85909eb3fbf02aefff7399282d7d9c81f124878543806cc307629752105c7156355c1cc

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [1.0.0](https://github.com/growsurf/growsurf-ruby/compare/v0.8.0...v1.0.0) (2026-07-03)
+
+
+### ⚠ BREAKING CHANGES
+
+* campaign create no longer accepts `options`, and campaign update no longer accepts the design / emails / options / notifications / installation config blobs — edit those via the new config sub-resources. Reward-config CRUD moved from /campaign/{id}/rewards to /campaign/{id}/reward-configs[/{campaignRewardId}].
+
+### Features
+
+* add campaign management endpoints; drop deprecated create/update config blobs ([c67a800](https://github.com/growsurf/growsurf-ruby/commit/c67a800670fe56394960e944f301ec068aeb50a9))
+
+## [0.8.0](https://github.com/growsurf/growsurf-ruby/compare/v0.7.0...v0.8.0) (2026-07-01)
+
+
+### Features
+
+* **api:** add campaign create/update/clone and program-reward CRUD ([aa8d3dd](https://github.com/growsurf/growsurf-ruby/commit/aa8d3ddbf167f26d0807ba58fce2071517afb318))
+
 ## 0.7.0 (2026-06-29)
 
 Full Changelog: [v0.6.1...v0.7.0](https://github.com/growsurf/growsurf-ruby/compare/v0.6.1...v0.7.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "growsurf-ruby", "~> 0.7.0"
+gem "growsurf-ruby", "~> 1.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/models/campaign/campaign_reward_list_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#list
+      class CampaignRewardListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute rewards
+        #   The program's active, visible, and enabled rewards.
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::Reward>]
+        required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::Reward] }
+
+        # @!method initialize(rewards:)
+        #   The list of a program's configured rewards.
+        #
+        #   @param rewards [Array<GrowsurfRuby::Models::Campaign::Reward>] The program's active, visible, and enabled rewards.
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/delete_reward_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#delete
+      class DeleteRewardResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #   The deleted reward ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(id:, success:)
+        #   @param id [String] The deleted reward ID.
+        #
+        #   @param success [Boolean]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/reward.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#create
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute is_unlimited
+        #
+        #   @return [Boolean]
+        required :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
+
+        # @!attribute metadata
+        #   Shallow custom metadata object.
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::Reward::Type]
+        required :type, enum: -> { GrowsurfRuby::Campaign::Reward::Type }
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure,
+                 nil?: true
+
+        # @!attribute conversions_required
+        #
+        #   @return [Integer, nil]
+        optional :conversions_required, Integer, api_name: :conversionsRequired, nil?: true
+
+        # @!attribute coupon_code
+        #
+        #   @return [String, nil]
+        optional :coupon_code, String, api_name: :couponCode, nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        optional :image_url, String, api_name: :imageUrl, nil?: true
+
+        # @!attribute limit
+        #   `-1` represents an unlimited reward in REST responses.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer, nil?: true
+
+        # @!attribute limit_duration
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::Reward::LimitDuration, nil]
+        optional :limit_duration,
+                 enum: -> { GrowsurfRuby::Campaign::Reward::LimitDuration },
+                 api_name: :limitDuration,
+                 nil?: true
+
+        # @!attribute next_milestone_prefix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
+
+        # @!attribute next_milestone_suffix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
+
+        # @!attribute number_of_winners
+        #
+        #   @return [Integer, nil]
+        optional :number_of_winners, Integer, api_name: :numberOfWinners, nil?: true
+
+        # @!attribute order
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer, nil?: true
+
+        # @!attribute referral_coupon_code
+        #   The coupon code delivered to the referred friend (double-sided rewards).
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
+
+        # @!attribute referral_description
+        #
+        #   @return [String, nil]
+        optional :referral_description, String, api_name: :referralDescription, nil?: true
+
+        # @!attribute referred_reward_upfront
+        #
+        #   @return [Boolean, nil]
+        optional :referred_reward_upfront,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :referredRewardUpfront
+
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue,
+                 nil?: true
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
+
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: 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, value: nil)
+        #   @param id [String]
+        #
+        #   @param is_unlimited [Boolean]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+        #
+        #   @param type [Symbol, GrowsurfRuby::Models::Campaign::Reward::Type]
+        #
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure, nil]
+        #
+        #   @param conversions_required [Integer, nil]
+        #
+        #   @param coupon_code [String, nil]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param image_url [String, nil]
+        #
+        #   @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
+        #
+        #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::Reward::LimitDuration, nil]
+        #
+        #   @param next_milestone_prefix [String, nil]
+        #
+        #   @param next_milestone_suffix [String, nil]
+        #
+        #   @param number_of_winners [Integer, nil]
+        #
+        #   @param order [Integer, nil]
+        #
+        #   @param referral_coupon_code [String, nil] The coupon code delivered to the referred friend (double-sided rewards).
+        #
+        #   @param referral_description [String, nil]
+        #
+        #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
+
+        # @see GrowsurfRuby::Models::Campaign::Reward#type
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED = :SINGLE_SIDED
+          DOUBLE_SIDED = :DOUBLE_SIDED
+          MILESTONE = :MILESTONE
+          LEADERBOARD = :LEADERBOARD
+          AFFILIATE = :AFFILIATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see GrowsurfRuby::Models::Campaign::Reward#limit_duration
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL = :IN_TOTAL
+          PER_MONTH = :PER_MONTH
+          PER_YEAR = :PER_YEAR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/reward_create_params.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Rewards#create
+      class RewardCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type]
+        required :type, enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::Type }
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure
+
+        # @!attribute conversions_required
+        #
+        #   @return [Integer, nil]
+        optional :conversions_required, Integer, api_name: :conversionsRequired
+
+        # @!attribute coupon_code
+        #
+        #   @return [String, nil]
+        optional :coupon_code, String, api_name: :couponCode
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        optional :image_url, String, api_name: :imageUrl
+
+        # @!attribute is_active
+        #
+        #   @return [Boolean, nil]
+        optional :is_active, GrowsurfRuby::Internal::Type::Boolean, api_name: :isActive
+
+        # @!attribute is_unlimited
+        #
+        #   @return [Boolean, nil]
+        optional :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
+
+        # @!attribute is_visible
+        #
+        #   @return [Boolean, nil]
+        optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute limit_duration
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration, nil]
+        optional :limit_duration,
+                 enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::LimitDuration },
+                 api_name: :limitDuration
+
+        # @!attribute metadata
+        #   Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute next_milestone_prefix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
+
+        # @!attribute next_milestone_suffix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
+
+        # @!attribute number_of_winners
+        #
+        #   @return [Integer, nil]
+        optional :number_of_winners, Integer, api_name: :numberOfWinners
+
+        # @!attribute order
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer
+
+        # @!attribute referral_coupon_code
+        #
+        #   @return [String, nil]
+        optional :referral_coupon_code, String, api_name: :referralCouponCode
+
+        # @!attribute referral_description
+        #
+        #   @return [String, nil]
+        optional :referral_description, String, api_name: :referralDescription
+
+        # @!attribute referred_reward_upfront
+        #
+        #   @return [Boolean, nil]
+        optional :referred_reward_upfront,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :referredRewardUpfront
+
+        # @!attribute referred_value
+        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Defaults to not tax-reportable (a purchase rebate).
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :referred_value,
+                 -> { GrowsurfRuby::RewardTaxValuation },
+                 api_name: :referredValue
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!attribute value
+        #   Tax valuation for the reward (the referrer's side of a double-sided reward).
+        #   Used by tax documentation / 1099 reporting.
+        #
+        #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+
+        # @!method initialize(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: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::RewardCreateParams} for more details.
+        #
+        #   @param type [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Type]
+        #
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure]
+        #
+        #   @param conversions_required [Integer]
+        #
+        #   @param coupon_code [String]
+        #
+        #   @param description [String]
+        #
+        #   @param image_url [String]
+        #
+        #   @param is_active [Boolean]
+        #
+        #   @param is_unlimited [Boolean]
+        #
+        #   @param is_visible [Boolean]
+        #
+        #   @param limit [Integer]
+        #
+        #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::LimitDuration]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Custom key/value metadata (single-level; values are stored as strings).
+        #
+        #   @param next_milestone_prefix [String]
+        #
+        #   @param next_milestone_suffix [String]
+        #
+        #   @param number_of_winners [Integer]
+        #
+        #   @param order [Integer]
+        #
+        #   @param referral_coupon_code [String]
+        #
+        #   @param referral_description [String]
+        #
+        #   @param referred_reward_upfront [Boolean]
+        #
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #
+        #   @param title [String]
+        #
+        #   @param value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the reward (the referrer's side of a double-sided reward). Use
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#type
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED = :SINGLE_SIDED
+          DOUBLE_SIDED = :DOUBLE_SIDED
+          MILESTONE = :MILESTONE
+          LEADERBOARD = :LEADERBOARD
+          AFFILIATE = :AFFILIATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#limit_duration
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL = :IN_TOTAL
+          PER_MONTH = :PER_MONTH
+          PER_YEAR = :PER_YEAR
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/reward_delete_params.rb

@@ -13,14 +13,14 @@ module GrowsurfRuby
         #   @return [String]
         required :id, String
 
-        # @!attribute reward_id
+        # @!attribute campaign_reward_id
         #
         #   @return [String]
-        required :reward_id, String
+        required :campaign_reward_id, String
 
-        # @!method initialize(id:, reward_id:, request_options: {})
+        # @!method initialize(id:, campaign_reward_id:, request_options: {})
         #   @param id [String]
-        #   @param reward_id [String]
+        #   @param campaign_reward_id [String]
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
       end
     end