straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/paykeys/paykey_verification_breakdown.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Straddle
+  module Models
+    PaykeyVerificationBreakdown = Paykeys::PaykeyVerificationBreakdown
+
+    module Paykeys
+      class PaykeyVerificationBreakdown < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::PaykeyVerificationBreakdown,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Straddle::Paykeys::AccountValidationDetails)) }
+        attr_reader :account_validation
+
+        sig do
+          params(
+            account_validation:
+              Straddle::Paykeys::AccountValidationDetails::OrHash
+          ).void
+        end
+        attr_writer :account_validation
+
+        sig { returns(T.nilable(Straddle::Paykeys::AccountNameMatchDetails)) }
+        attr_reader :name_match
+
+        sig do
+          params(
+            name_match: Straddle::Paykeys::AccountNameMatchDetails::OrHash
+          ).void
+        end
+        attr_writer :name_match
+
+        sig do
+          params(
+            account_validation:
+              Straddle::Paykeys::AccountValidationDetails::OrHash,
+            name_match: Straddle::Paykeys::AccountNameMatchDetails::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(account_validation: nil, name_match: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              account_validation: Straddle::Paykeys::AccountValidationDetails,
+              name_match: Straddle::Paykeys::AccountNameMatchDetails
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykeys/paykey_verification_details.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Straddle
+  module Models
+    PaykeyVerificationDetails = Paykeys::PaykeyVerificationDetails
+
+    module Paykeys
+      class PaykeyVerificationDetails < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::PaykeyVerificationDetails,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the verification details.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Straddle::Paykeys::PaykeyVerificationBreakdown) }
+        attr_reader :breakdown
+
+        sig do
+          params(
+            breakdown: Straddle::Paykeys::PaykeyVerificationBreakdown::OrHash
+          ).void
+        end
+        attr_writer :breakdown
+
+        # Timestamp of when the verification was initiated.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig do
+          returns(Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol)
+        end
+        attr_accessor :decision
+
+        # Messages returned by the paykey verification process.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :messages
+
+        # Timestamp of the most recent update to the verification details.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            id: String,
+            breakdown: Straddle::Paykeys::PaykeyVerificationBreakdown::OrHash,
+            created_at: Time,
+            decision: Straddle::Paykeys::PaykeyVerificationResult::OrSymbol,
+            messages: T::Hash[Symbol, String],
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the verification details.
+          id:,
+          breakdown:,
+          # Timestamp of when the verification was initiated.
+          created_at:,
+          decision:,
+          # Messages returned by the paykey verification process.
+          messages:,
+          # Timestamp of the most recent update to the verification details.
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              breakdown: Straddle::Paykeys::PaykeyVerificationBreakdown,
+              created_at: Time,
+              decision:
+                Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol,
+              messages: T::Hash[Symbol, String],
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykeys/paykey_verification_result.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Straddle
+  module Models
+    PaykeyVerificationResult = Paykeys::PaykeyVerificationResult
+
+    module Paykeys
+      module PaykeyVerificationResult
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::Paykeys::PaykeyVerificationResult)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCEPT =
+          T.let(
+            :accept,
+            Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol
+          )
+        REJECT =
+          T.let(
+            :reject,
+            Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol
+          )
+        REVIEW =
+          T.let(
+            :review,
+            Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::Paykeys::PaykeyVerificationResult::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykeys/review_list_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Paykeys
+      class ReviewListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::ReviewListParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Optional client-generated identifier for tracing a series of related requests.
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        # Optional client-generated identifier for tracing one request.
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # For platform requests, the embedded account UUID that sets the request scope.
+        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(
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Optional client-generated identifier for tracing a series of related requests.
+          correlation_id: nil,
+          # Optional client-generated identifier for tracing one request.
+          request_id: nil,
+          # For platform requests, the embedded account UUID that sets the request scope.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              correlation_id: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykeys/review_set_verification_decision_params.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Paykeys
+      class ReviewSetVerificationDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::ReviewSetVerificationDecisionParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::OrSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Optional client-generated identifier for tracing a series of related requests.
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        # Optional client-generated key for an idempotent request.
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        # Optional client-generated identifier for tracing one request.
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # For platform requests, the embedded account UUID that sets the request scope.
+        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(
+            id: String,
+            status:
+              Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::OrSymbol,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          status:,
+          # Optional client-generated identifier for tracing a series of related requests.
+          correlation_id: nil,
+          # Optional client-generated key for an idempotent request.
+          idempotency_key: nil,
+          # Optional client-generated identifier for tracing one request.
+          request_id: nil,
+          # For platform requests, the embedded account UUID that sets the request scope.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::OrSymbol,
+              correlation_id: String,
+              idempotency_key: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Paykeys::ReviewSetVerificationDecisionParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/payment_authorization_proof.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaymentAuthorizationProof < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::PaymentAuthorizationProof,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for this document.
+      sig { returns(String) }
+      attr_accessor :document_id
+
+      # The file name of this document as uploaded.
+      sig { returns(String) }
+      attr_accessor :document_name
+
+      # The size of this document in bytes.
+      sig { returns(Integer) }
+      attr_accessor :document_size
+
+      sig { returns(Straddle::PaymentDocumentType::TaggedSymbol) }
+      attr_accessor :document_type
+
+      # The UTC timestamp when this document was uploaded.
+      sig { returns(Time) }
+      attr_accessor :uploaded_at
+
+      sig do
+        params(
+          document_id: String,
+          document_name: String,
+          document_size: Integer,
+          document_type: Straddle::PaymentDocumentType::OrSymbol,
+          uploaded_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for this document.
+        document_id:,
+        # The file name of this document as uploaded.
+        document_name:,
+        # The size of this document in bytes.
+        document_size:,
+        document_type:,
+        # The UTC timestamp when this document was uploaded.
+        uploaded_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            document_id: String,
+            document_name: String,
+            document_size: Integer,
+            document_type: Straddle::PaymentDocumentType::TaggedSymbol,
+            uploaded_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/payment_device.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaymentDevice < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaymentDevice, Straddle::Internal::AnyHash)
+        end
+
+      # The IP address of the device used when the customer authorized the charge or
+      # payout. Use `0.0.0.0` to represent an offline consent interaction.
+      sig { returns(String) }
+      attr_accessor :ip_address
+
+      sig { params(ip_address: String).returns(T.attached_class) }
+      def self.new(
+        # The IP address of the device used when the customer authorized the charge or
+        # payout. Use `0.0.0.0` to represent an offline consent interaction.
+        ip_address:
+      )
+      end
+
+      sig { override.returns({ ip_address: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/payment_document_type.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module PaymentDocumentType
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Straddle::PaymentDocumentType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PAYMENT_AUTHORIZATION =
+        T.let(
+          :payment_authorization,
+          Straddle::PaymentDocumentType::TaggedSymbol
+        )
+
+      sig do
+        override.returns(T::Array[Straddle::PaymentDocumentType::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end