growsurf-ruby 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c971f7f825ae2b01c5ac6c90c1bb0ea6cb98e62f806d50d96ebacf0f060e64c
-  data.tar.gz: cd5ea6ea42c870db2b39d635e75c90b50ba630010b918618d9a339353311178f
+  metadata.gz: 3ea326d15c05d8c75b86335b99e152c1e269196cc3603ed96b38a11281509a26
+  data.tar.gz: ccc73ce7424bd230f00745bc08d843c5a1bcee077468c5ee5d01ee497578f9e2
 SHA512:
-  metadata.gz: 6156285b4fcc4ea5e21e3ebbb24b8fa566ba91f3dfac3de601816c2fc22140caaca8190b5dfa8594ae686066953a76b46152dacd9f4befc336b0ec8a6649ef2e
-  data.tar.gz: 2a819a4fb207ec68a72b1d17accefba64e53627ec777bda3029322aab0abbb96063340bd5a57fa647a96dbc37e0f5542e311ff05e22608c63591fe604fe333a2
+  metadata.gz: 67581d38788ab7a27e22a1f5d010e6a85e152ded9d3f5ffd512c22dd2ac52df70452254fdb02a91b237ef416f27a5326df0240b4111ce2b67bd1f8606b64d00b
+  data.tar.gz: 05b6ad5c2614c5ba9647bd7b54874d2feeb720659f2ae7930252afc48781d100fe0edac724b2b5f7ef789f0a75851621c0b73de2c4226a3b7602515227627c5e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [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)
+
+### Features
+
+* **api:** support delayed referral rewards and affiliate refunds ([d707d44](https://github.com/growsurf/growsurf-ruby/commit/d707d443a5806f3e117532d4032386390e2654a5))
+
 ## 0.6.1 (2026-06-26)
 
 Full Changelog: [v0.6.0...v0.6.1](https://github.com/growsurf/growsurf-ruby/compare/v0.6.0...v0.6.1)

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.6.1"
+gem "growsurf-ruby", "~> 0.8.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/participant_cancel_delayed_referral_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#cancel_delayed_referral
+      class ParticipantCancelDelayedReferralParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!method initialize(id:, participant_id_or_email:, request_options: {})
+        #   @param id [String]
+        #   @param participant_id_or_email [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#cancel_delayed_referral
+      class ParticipantCancelDelayedReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(success:, message: nil)
+        #   @param success [Boolean]
+        #   @param message [String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#refund_transaction
+      class ParticipantRefundTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!attribute amendment_type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::AmendmentType, nil]
+        optional :amendment_type,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType },
+                 api_name: :amendmentType
+
+        # @!attribute amount
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer
+
+        # @!attribute amount_refunded
+        #
+        #   @return [Integer, nil]
+        optional :amount_refunded, Integer, api_name: :amountRefunded
+
+        # @!attribute charge_id
+        #
+        #   @return [String, nil]
+        optional :charge_id, String, api_name: :chargeId
+
+        # @!attribute currency
+        #
+        #   @return [String, nil]
+        optional :currency, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute external_id
+        #
+        #   @return [String, nil]
+        optional :external_id, String, api_name: :externalId
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String, api_name: :invoiceId
+
+        # @!attribute order_id
+        #
+        #   @return [String, nil]
+        optional :order_id, String, api_name: :orderId
+
+        # @!attribute payment_id
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, api_name: :paymentId
+
+        # @!attribute payment_intent_id
+        #
+        #   @return [String, nil]
+        optional :payment_intent_id, String, api_name: :paymentIntentId
+
+        # @!attribute refund_amount
+        #
+        #   @return [Integer, nil]
+        optional :refund_amount, Integer, api_name: :refundAmount
+
+        # @!attribute refund_id
+        #
+        #   @return [String, nil]
+        optional :refund_id, String, api_name: :refundId
+
+        # @!attribute refund_status
+        #
+        #   @return [String, nil]
+        optional :refund_status, String, api_name: :refundStatus
+
+        # @!attribute transaction_id
+        #
+        #   @return [String, nil]
+        optional :transaction_id, String, api_name: :transactionId
+
+        # @!method initialize(id:, participant_id_or_email:, amendment_type: nil, amount: nil, amount_refunded: nil, charge_id: nil, currency: nil, description: nil, external_id: nil, invoice_id: nil, order_id: nil, payment_id: nil, payment_intent_id: nil, refund_amount: nil, refund_id: nil, refund_status: nil, transaction_id: nil, request_options: {})
+        #   @param id [String]
+        #   @param participant_id_or_email [String]
+        #   @param amendment_type [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::AmendmentType]
+        #   @param amount [Integer]
+        #   @param amount_refunded [Integer]
+        #   @param charge_id [String]
+        #   @param currency [String]
+        #   @param description [String]
+        #   @param external_id [String]
+        #   @param invoice_id [String]
+        #   @param order_id [String]
+        #   @param payment_id [String]
+        #   @param payment_intent_id [String]
+        #   @param refund_amount [Integer]
+        #   @param refund_id [String]
+        #   @param refund_status [String]
+        #   @param transaction_id [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFUND = :REFUND
+          CHARGEBACK = :CHARGEBACK
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#refund_transaction
+      class ParticipantRefundTransactionResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute adjusted
+        #
+        #   @return [Integer]
+        required :adjusted, Integer
+
+        # @!attribute amendment_type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType]
+        required :amendment_type,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantRefundTransactionResponse::AmendmentType },
+                 api_name: :amendmentType
+
+        # @!attribute deleted
+        #
+        #   @return [Integer]
+        required :deleted, Integer
+
+        # @!attribute matched
+        #
+        #   @return [Integer]
+        required :matched, Integer
+
+        # @!attribute matching_commission_ids
+        #
+        #   @return [Array<String>]
+        required :matching_commission_ids,
+                 GrowsurfRuby::Internal::Type::ArrayOf[String],
+                 api_name: :matchingCommissionIds
+
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute reversed
+        #
+        #   @return [Integer]
+        required :reversed, Integer
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute not_found
+        #
+        #   @return [Boolean, nil]
+        optional :not_found, GrowsurfRuby::Internal::Type::Boolean, api_name: :notFound
+
+        # @!method initialize(adjusted:, amendment_type:, deleted:, matched:, matching_commission_ids:, message:, reversed:, success:, not_found: nil)
+        #   @param adjusted [Integer]
+        #   @param amendment_type [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType]
+        #   @param deleted [Integer]
+        #   @param matched [Integer]
+        #   @param matching_commission_ids [Array<String>]
+        #   @param message [String]
+        #   @param reversed [Integer]
+        #   @param success [Boolean]
+        #   @param not_found [Boolean]
+
+        # @see GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse#amendment_type
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          REFUND = :REFUND
+          CHARGEBACK = :CHARGEBACK
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -18,9 +18,27 @@ module GrowsurfRuby
         #   @return [String]
         required :participant_id_or_email, String
 
-        # @!method initialize(id:, participant_id_or_email:, request_options: {})
+        # @!attribute delay_in_days
+        #   Number of whole days to hold referral credit before it is awarded. Useful for
+        #   honoring a refund window before crediting a referrer. Omit this field to award
+        #   credit immediately. The credit is awarded automatically once the delay elapses,
+        #   and can be cancelled before then with the Cancel delayed referral trigger
+        #   request.
+        #
+        #   @return [Integer, nil]
+        optional :delay_in_days, Integer, api_name: :delayInDays
+
+        # @!method initialize(id:, participant_id_or_email:, delay_in_days: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralParams} for more
+        #   details.
+        #
         #   @param id [String]
+        #
         #   @param participant_id_or_email [String]
+        #
+        #   @param delay_in_days [Integer] Number of whole days to hold referral credit before it is awarded. Useful for
+        #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -0,0 +1,166 @@
+# 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_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
+
+        # @!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_description: nil, referred_reward_upfront: 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_description [String, nil]
+        #
+        #   @param referred_reward_upfront [Boolean]
+
+        # @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