growsurf-ruby 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c971f7f825ae2b01c5ac6c90c1bb0ea6cb98e62f806d50d96ebacf0f060e64c
-  data.tar.gz: cd5ea6ea42c870db2b39d635e75c90b50ba630010b918618d9a339353311178f
+  metadata.gz: be12c4785ae7a40c39c8e74aeeddcc53359c12bdad594d2578b7da9e1bc1b20d
+  data.tar.gz: cb49bb681ce1bd2291b3468df5b2186f23ea41d0262210a963652934689aa956
 SHA512:
-  metadata.gz: 6156285b4fcc4ea5e21e3ebbb24b8fa566ba91f3dfac3de601816c2fc22140caaca8190b5dfa8594ae686066953a76b46152dacd9f4befc336b0ec8a6649ef2e
-  data.tar.gz: 2a819a4fb207ec68a72b1d17accefba64e53627ec777bda3029322aab0abbb96063340bd5a57fa647a96dbc37e0f5542e311ff05e22608c63591fe604fe333a2
+  metadata.gz: d3b33af554e8fac71c6c3e4df21a5565c188fee651fe4d316f6c0486c0349c460bb737e2a96c852bd8856aa01e469bbf3c65c5314617b5a800423f9558e3fa70
+  data.tar.gz: db54fe7cfff4279d0af2d57589aa66106a2e0b83ce59c5a37fe6809145cca0edc59a0b3dab2a0a51c93592a1016b55564469ff05a6934ec0973ad206c5f35ffe

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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.7.0"
 ```
 
 <!-- x-release-please-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/resources/campaign/participant.rb

@@ -377,6 +377,66 @@ module GrowsurfRuby
           )
         end
 
+        # Records an amendment (refund, partial refund, refund cancellation, or
+        # chargeback) against a previously recorded transaction and reverses or adjusts
+        # the referrer's commission.
+        #
+        # @overload refund_transaction(participant_id_or_email, id:, 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 participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
+        #
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param amendment_type [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::AmendmentType] Body param
+        #
+        # @param amount [Integer] Body param
+        #
+        # @param amount_refunded [Integer] Body param
+        #
+        # @param charge_id [String] Body param
+        #
+        # @param currency [String] Body param
+        #
+        # @param description [String] Body param
+        #
+        # @param external_id [String] Body param
+        #
+        # @param invoice_id [String] Body param
+        #
+        # @param order_id [String] Body param
+        #
+        # @param payment_id [String] Body param
+        #
+        # @param payment_intent_id [String] Body param
+        #
+        # @param refund_amount [Integer] Body param
+        #
+        # @param refund_id [String] Body param
+        #
+        # @param refund_status [String] Body param
+        #
+        # @param transaction_id [String] Body param
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams
+        def refund_transaction(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantRefundTransactionParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/participant/%2$s/transaction/refund", id, participant_id_or_email],
+            body: parsed,
+            model: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse,
+            options: options
+          )
+        end
+
         # Sends email invites on behalf of a participant to a list of email addresses.
         #
         # @overload send_invites(participant_id_or_email, id:, email_addresses:, message_text:, subject_text:, request_options: {})
@@ -411,14 +471,20 @@ module GrowsurfRuby
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralParams} for more
+        # details.
+        #
         # Triggers referral credit for an existing referred participant by GrowSurf
         # participant ID or email address.
         #
-        # @overload trigger_referral(participant_id_or_email, id:, request_options: {})
+        # @overload trigger_referral(participant_id_or_email, id:, delay_in_days: nil, request_options: {})
         #
-        # @param participant_id_or_email [String] GrowSurf participant ID or URL-encoded participant email address.
+        # @param participant_id_or_email [String] Path param: GrowSurf participant ID or URL-encoded participant email address.
         #
-        # @param id [String] GrowSurf program ID.
+        # @param id [String] Path param: GrowSurf program ID.
+        #
+        # @param delay_in_days [Integer] Body param: Number of whole days to hold referral credit before it is awarded. U
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -434,11 +500,40 @@ module GrowsurfRuby
           @client.request(
             method: :post,
             path: ["campaign/%1$s/participant/%2$s/ref", id, participant_id_or_email],
+            body: parsed,
             model: GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse,
             options: options
           )
         end
 
+        # Cancels a pending delayed referral trigger for an existing referred participant
+        # by GrowSurf participant ID or email address.
+        #
+        # @overload cancel_delayed_referral(participant_id_or_email, id:, request_options: {})
+        #
+        # @param participant_id_or_email [String] GrowSurf participant ID or URL-encoded participant email address.
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralParams
+        def cancel_delayed_referral(participant_id_or_email, params)
+          parsed, options = GrowsurfRuby::Campaign::ParticipantCancelDelayedReferralParams.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/participant/%2$s/ref", id, participant_id_or_email],
+            model: GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [GrowsurfRuby::Client]

data/lib/growsurf_ruby/version.rb

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

data/lib/growsurf_ruby.rb

@@ -60,6 +60,8 @@ require_relative "growsurf_ruby/models/campaign/commission_delete_params"
 require_relative "growsurf_ruby/models/campaign/commission_delete_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"
+require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response"
 require_relative "growsurf_ruby/models/campaign/participant_delete_params"
 require_relative "growsurf_ruby/models/campaign/participant_delete_response"
 require_relative "growsurf_ruby/models/campaign/participant_list_commissions_params"
@@ -69,6 +71,8 @@ require_relative "growsurf_ruby/models/campaign/participant_list_rewards_params"
 require_relative "growsurf_ruby/models/campaign/participant_list_rewards_response"
 require_relative "growsurf_ruby/models/campaign/participant_record_transaction_params"
 require_relative "growsurf_ruby/models/campaign/participant_record_transaction_response"
+require_relative "growsurf_ruby/models/campaign/participant_refund_transaction_params"
+require_relative "growsurf_ruby/models/campaign/participant_refund_transaction_response"
 require_relative "growsurf_ruby/models/campaign/participant_retrieve_params"
 require_relative "growsurf_ruby/models/campaign/participant_reward"
 require_relative "growsurf_ruby/models/campaign/participant_send_invites_params"

data/rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantCancelDelayedReferralParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantCancelDelayedReferralParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, participant_id_or_email:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantCancelDelayedReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        sig do
+          params(success: T::Boolean, message: String).returns(T.attached_class)
+        end
+        def self.new(success:, message: nil)
+        end
+
+        sig { override.returns({ success: T::Boolean, message: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end