growsurf-ruby 0.6.0 → 0.7.0

data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRefundTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol
+            )
+          )
+        end
+        attr_reader :amendment_type
+
+        sig do
+          params(
+            amendment_type:
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol
+          ).void
+        end
+        attr_writer :amendment_type
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount
+
+        sig { params(amount: Integer).void }
+        attr_writer :amount
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount_refunded
+
+        sig { params(amount_refunded: Integer).void }
+        attr_writer :amount_refunded
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :charge_id
+
+        sig { params(charge_id: String).void }
+        attr_writer :charge_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :currency
+
+        sig { params(currency: String).void }
+        attr_writer :currency
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :external_id
+
+        sig { params(external_id: String).void }
+        attr_writer :external_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :invoice_id
+
+        sig { params(invoice_id: String).void }
+        attr_writer :invoice_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :order_id
+
+        sig { params(order_id: String).void }
+        attr_writer :order_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_id
+
+        sig { params(payment_id: String).void }
+        attr_writer :payment_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_intent_id
+
+        sig { params(payment_intent_id: String).void }
+        attr_writer :payment_intent_id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :refund_amount
+
+        sig { params(refund_amount: Integer).void }
+        attr_writer :refund_amount
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :refund_id
+
+        sig { params(refund_id: String).void }
+        attr_writer :refund_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :refund_status
+
+        sig { params(refund_status: String).void }
+        attr_writer :refund_status
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :transaction_id
+
+        sig { params(transaction_id: String).void }
+        attr_writer :transaction_id
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            amendment_type:
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol,
+            amount: Integer,
+            amount_refunded: Integer,
+            charge_id: String,
+            currency: String,
+            description: String,
+            external_id: String,
+            invoice_id: String,
+            order_id: String,
+            payment_id: String,
+            payment_intent_id: String,
+            refund_amount: Integer,
+            refund_id: String,
+            refund_status: String,
+            transaction_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              amendment_type:
+                GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol,
+              amount: Integer,
+              amount_refunded: Integer,
+              charge_id: String,
+              currency: String,
+              description: String,
+              external_id: String,
+              invoice_id: String,
+              order_id: String,
+              payment_id: String,
+              payment_intent_id: String,
+              refund_amount: Integer,
+              refund_id: String,
+              refund_status: String,
+              transaction_id: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REFUND =
+            T.let(
+              :REFUND,
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::TaggedSymbol
+            )
+          CHARGEBACK =
+            T.let(
+              :CHARGEBACK,
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRefundTransactionResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :adjusted
+
+        sig do
+          returns(
+            GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::TaggedSymbol
+          )
+        end
+        attr_accessor :amendment_type
+
+        sig { returns(Integer) }
+        attr_accessor :deleted
+
+        sig { returns(Integer) }
+        attr_accessor :matched
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :matching_commission_ids
+
+        sig { returns(String) }
+        attr_accessor :message
+
+        sig { returns(Integer) }
+        attr_accessor :reversed
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :not_found
+
+        sig { params(not_found: T::Boolean).void }
+        attr_writer :not_found
+
+        sig do
+          params(
+            adjusted: Integer,
+            amendment_type:
+              GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::OrSymbol,
+            deleted: Integer,
+            matched: Integer,
+            matching_commission_ids: T::Array[String],
+            message: String,
+            reversed: Integer,
+            success: T::Boolean,
+            not_found: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          adjusted:,
+          amendment_type:,
+          deleted:,
+          matched:,
+          matching_commission_ids:,
+          message:,
+          reversed:,
+          success:,
+          not_found: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              adjusted: Integer,
+              amendment_type:
+                GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::TaggedSymbol,
+              deleted: Integer,
+              matched: Integer,
+              matching_commission_ids: T::Array[String],
+              message: String,
+              reversed: Integer,
+              success: T::Boolean,
+              not_found: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AmendmentType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REFUND =
+            T.let(
+              :REFUND,
+              GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::TaggedSymbol
+            )
+          CHARGEBACK =
+            T.let(
+              :CHARGEBACK,
+              GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::AmendmentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi

@@ -21,14 +21,36 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :participant_id_or_email
 
+        # 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.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :delay_in_days
+
+        sig { params(delay_in_days: Integer).void }
+        attr_writer :delay_in_days
+
         sig do
           params(
             id: String,
             participant_id_or_email: String,
+            delay_in_days: Integer,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(id:, participant_id_or_email:, request_options: {})
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          # 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.
+          delay_in_days: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +58,7 @@ module GrowsurfRuby
             {
               id: String,
               participant_id_or_email: String,
+              delay_in_days: Integer,
               request_options: GrowsurfRuby::RequestOptions
             }
           )

data/rbi/growsurf_ruby/models/participant_commission_list.rbi

@@ -60,7 +60,7 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :id
 
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :amount
 
         sig { returns(Integer) }
@@ -75,7 +75,7 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :referrer_id
 
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :sale_amount
 
         sig do
@@ -134,17 +134,17 @@ module GrowsurfRuby
         attr_writer :reversed_at
 
         sig { returns(T.nilable(Integer)) }
-        attr_accessor :sale_amount_amount_in_campaign_currency
+        attr_accessor :sale_amount_in_campaign_currency
 
         sig do
           params(
             id: String,
-            amount: Integer,
+            amount: T.nilable(Integer),
             created_at: Integer,
             currency_iso: String,
             referred_id: String,
             referrer_id: String,
-            sale_amount: Integer,
+            sale_amount: T.nilable(Integer),
             status:
               GrowsurfRuby::ParticipantCommissionList::Commission::Status::OrSymbol,
             amount_in_campaign_currency: T.nilable(Integer),
@@ -158,7 +158,7 @@ module GrowsurfRuby
             payout_queued_at: Integer,
             provider: T.nilable(String),
             reversed_at: Integer,
-            sale_amount_amount_in_campaign_currency: T.nilable(Integer)
+            sale_amount_in_campaign_currency: T.nilable(Integer)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -181,7 +181,7 @@ module GrowsurfRuby
           payout_queued_at: nil,
           provider: nil,
           reversed_at: nil,
-          sale_amount_amount_in_campaign_currency: nil
+          sale_amount_in_campaign_currency: nil
         )
         end
 
@@ -189,12 +189,12 @@ module GrowsurfRuby
           override.returns(
             {
               id: String,
-              amount: Integer,
+              amount: T.nilable(Integer),
               created_at: Integer,
               currency_iso: String,
               referred_id: String,
               referrer_id: String,
-              sale_amount: Integer,
+              sale_amount: T.nilable(Integer),
               status:
                 GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol,
               amount_in_campaign_currency: T.nilable(Integer),
@@ -208,7 +208,7 @@ module GrowsurfRuby
               payout_queued_at: Integer,
               provider: T.nilable(String),
               reversed_at: Integer,
-              sale_amount_amount_in_campaign_currency: T.nilable(Integer)
+              sale_amount_in_campaign_currency: T.nilable(Integer)
             }
           )
         end

data/rbi/growsurf_ruby/models/participant_payout_list.rbi

@@ -109,6 +109,12 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :provider
 
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :queued_at
+
+        sig { params(queued_at: Integer).void }
+        attr_writer :queued_at
+
         sig do
           params(
             id: String,
@@ -126,7 +132,8 @@ module GrowsurfRuby
             failed_at: Integer,
             fx_error: T.nilable(String),
             issued_at: Integer,
-            provider: T.nilable(String)
+            provider: T.nilable(String),
+            queued_at: Integer
           ).returns(T.attached_class)
         end
         def self.new(
@@ -144,7 +151,8 @@ module GrowsurfRuby
           failed_at: nil,
           fx_error: nil,
           issued_at: nil,
-          provider: nil
+          provider: nil,
+          queued_at: nil
         )
         end
 
@@ -166,7 +174,8 @@ module GrowsurfRuby
               failed_at: Integer,
               fx_error: T.nilable(String),
               issued_at: Integer,
-              provider: T.nilable(String)
+              provider: T.nilable(String),
+              queued_at: Integer
             }
           )
         end

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -332,6 +332,73 @@ 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.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            amendment_type:
+              GrowsurfRuby::Campaign::ParticipantRefundTransactionParams::AmendmentType::OrSymbol,
+            amount: Integer,
+            amount_refunded: Integer,
+            charge_id: String,
+            currency: String,
+            description: String,
+            external_id: String,
+            invoice_id: String,
+            order_id: String,
+            payment_id: String,
+            payment_intent_id: String,
+            refund_amount: Integer,
+            refund_id: String,
+            refund_status: String,
+            transaction_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
+          )
+        end
+        def refund_transaction(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          amendment_type: nil,
+          # Body param
+          amount: nil,
+          # Body param
+          amount_refunded: nil,
+          # Body param
+          charge_id: nil,
+          # Body param
+          currency: nil,
+          # Body param
+          description: nil,
+          # Body param
+          external_id: nil,
+          # Body param
+          invoice_id: nil,
+          # Body param
+          order_id: nil,
+          # Body param
+          payment_id: nil,
+          # Body param
+          payment_intent_id: nil,
+          # Body param
+          refund_amount: nil,
+          # Body param
+          refund_id: nil,
+          # Body param
+          refund_status: nil,
+          # Body param
+          transaction_id: nil,
+          request_options: {}
+        )
+        end
+
         # Sends email invites on behalf of a participant to a list of email addresses.
         sig do
           params(
@@ -366,12 +433,39 @@ module GrowsurfRuby
           params(
             participant_id_or_email: String,
             id: String,
+            delay_in_days: Integer,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(
             GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse
           )
         end
         def trigger_referral(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param: 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.
+          delay_in_days: nil,
+          request_options: {}
+        )
+        end
+
+        # Cancels a pending delayed referral trigger for an existing referred participant
+        # by GrowSurf participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse
+          )
+        end
+        def cancel_delayed_referral(
           # GrowSurf participant ID or URL-encoded participant email address.
           participant_id_or_email,
           # GrowSurf program ID.

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

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_cancel_delayed_referral_params =
+        { id: String, participant_id_or_email: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantCancelDelayedReferralParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_cancel_delayed_referral_response =
+        { success: bool, message: String }
+
+      class ParticipantCancelDelayedReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        attr_reader message: String?
+
+        def message=: (String) -> String
+
+        def initialize: (success: bool, ?message: String) -> void
+
+        def to_hash: -> { success: bool, message: String }
+      end
+    end
+  end
+end