straddle 0.1.0.pre.alpha.1

data/rbi/straddle/models/payout_update_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PayoutUpdateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PayoutUpdateParams, Straddle::Internal::AnyHash)
+        end
+
+      # The amount of the payout in cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # An arbitrary description for the payout.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The desired date on which the payment should be occur. For payouts, this means
+      # the date you want the funds to be sent from your bank account.
+      sig { returns(Date) }
+      attr_accessor :payment_date
+
+      # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+      # information about the payout in a structured format.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :straddle_account_id
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          amount: Integer,
+          description: String,
+          payment_date: Date,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The amount of the payout in cents.
+        amount:,
+        # An arbitrary description for the payout.
+        description:,
+        # The desired date on which the payment should be occur. For payouts, this means
+        # the date you want the funds to be sent from your bank account.
+        payment_date:,
+        # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        # information about the payout in a structured format.
+        metadata: nil,
+        correlation_id: nil,
+        request_id: nil,
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount: Integer,
+            description: String,
+            payment_date: Date,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end