straddle 0.1.0.pre.alpha.1

data/rbi/straddle/models/customers/identity_verification_breakdown_v1.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationBreakdownV1 < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::IdentityVerificationBreakdownV1,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # List of specific result codes from the fraud and risk screening.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :codes
+
+        sig do
+          returns(
+            T.nilable(
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :correlation
+
+        sig do
+          params(
+            correlation:
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::OrSymbol
+          ).void
+        end
+        attr_writer :correlation
+
+        # Represents the strength of the correlation between provided and known
+        # information. A higher score indicates a stronger correlation.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :correlation_score
+
+        sig do
+          returns(
+            T.nilable(
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :decision
+
+        sig do
+          params(
+            decision:
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::OrSymbol
+          ).void
+        end
+        attr_writer :decision
+
+        # Predicts the inherent risk associated with the customer for a given module. A
+        # higher score indicates a greater likelihood of fraud.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :risk_score
+
+        sig do
+          params(
+            codes: T.nilable(T::Array[String]),
+            correlation:
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::OrSymbol,
+            correlation_score: T.nilable(Float),
+            decision:
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::OrSymbol,
+            risk_score: T.nilable(Float)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List of specific result codes from the fraud and risk screening.
+          codes: nil,
+          correlation: nil,
+          # Represents the strength of the correlation between provided and known
+          # information. A higher score indicates a stronger correlation.
+          correlation_score: nil,
+          decision: nil,
+          # Predicts the inherent risk associated with the customer for a given module. A
+          # higher score indicates a greater likelihood of fraud.
+          risk_score: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              codes: T.nilable(T::Array[String]),
+              correlation:
+                Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol,
+              correlation_score: T.nilable(Float),
+              decision:
+                Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol,
+              risk_score: T.nilable(Float)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Correlation
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Customers::IdentityVerificationBreakdownV1::Correlation
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW_CONFIDENCE =
+            T.let(
+              :low_confidence,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+          POTENTIAL_MATCH =
+            T.let(
+              :potential_match,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+          LIKELY_MATCH =
+            T.let(
+              :likely_match,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+          HIGH_CONFIDENCE =
+            T.let(
+              :high_confidence,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Customers::IdentityVerificationBreakdownV1::Correlation::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Decision
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Customers::IdentityVerificationBreakdownV1::Decision
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACCEPT =
+            T.let(
+              :accept,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol
+            )
+          REJECT =
+            T.let(
+              :reject,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol
+            )
+          REVIEW =
+            T.let(
+              :review,
+              Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Customers::IdentityVerificationBreakdownV1::Decision::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/review_decision_params.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReviewDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReviewDecisionParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # The final status of the customer review.
+        sig do
+          returns(Straddle::Customers::ReviewDecisionParams::Status::OrSymbol)
+        end
+        attr_accessor :status
+
+        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(
+            status: Straddle::Customers::ReviewDecisionParams::Status::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The final status of the customer review.
+          status:,
+          correlation_id: nil,
+          request_id: nil,
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              status:
+                Straddle::Customers::ReviewDecisionParams::Status::OrSymbol,
+              correlation_id: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The final status of the customer review.
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Customers::ReviewDecisionParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VERIFIED =
+            T.let(
+              :verified,
+              Straddle::Customers::ReviewDecisionParams::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Straddle::Customers::ReviewDecisionParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Customers::ReviewDecisionParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/review_get_params.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReviewGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReviewGetParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        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(
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          correlation_id: nil,
+          request_id: nil,
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              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/device_info_v1.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class DeviceInfoV1 < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::DeviceInfoV1, 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/device_unmasked_v1.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class DeviceUnmaskedV1 < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::DeviceUnmaskedV1, Straddle::Internal::AnyHash)
+        end
+
+      # The customer's IP address at the time of profile creation. Use `0.0.0.0` to
+      # represent an offline customer registration.
+      sig { returns(String) }
+      attr_accessor :ip_address
+
+      sig { params(ip_address: String).returns(T.attached_class) }
+      def self.new(
+        # The customer's IP address at the time of profile creation. Use `0.0.0.0` to
+        # represent an offline customer registration.
+        ip_address:
+      )
+      end
+
+      sig { override.returns({ ip_address: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/account_create_params.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class AccountCreateParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::AccountCreateParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # The access level granted to the account. This is determined by your platform
+        # configuration. Use `standard` unless instructed otherwise by Straddle.
+        sig do
+          returns(Straddle::Embed::AccountCreateParams::AccessLevel::OrSymbol)
+        end
+        attr_accessor :access_level
+
+        # The type of account to be created. Currently, only `business` is supported.
+        sig do
+          returns(Straddle::Embed::AccountCreateParams::AccountType::OrSymbol)
+        end
+        attr_accessor :account_type
+
+        sig { returns(Straddle::Embed::BusinessProfileV1) }
+        attr_reader :business_profile
+
+        sig do
+          params(
+            business_profile: Straddle::Embed::BusinessProfileV1::OrHash
+          ).void
+        end
+        attr_writer :business_profile
+
+        # The unique identifier of the organization related to this account.
+        sig { returns(String) }
+        attr_accessor :organization_id
+
+        # Unique identifier for the account in your database, used for cross-referencing
+        # between Straddle and your systems.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
+        # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        # information about the account in a structured format.
+        sig { returns(T.nilable(T::Hash[Symbol, T.nilable(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 do
+          params(
+            access_level:
+              Straddle::Embed::AccountCreateParams::AccessLevel::OrSymbol,
+            account_type:
+              Straddle::Embed::AccountCreateParams::AccountType::OrSymbol,
+            business_profile: Straddle::Embed::BusinessProfileV1::OrHash,
+            organization_id: String,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The access level granted to the account. This is determined by your platform
+          # configuration. Use `standard` unless instructed otherwise by Straddle.
+          access_level:,
+          # The type of account to be created. Currently, only `business` is supported.
+          account_type:,
+          business_profile:,
+          # The unique identifier of the organization related to this account.
+          organization_id:,
+          # Unique identifier for the account in your database, used for cross-referencing
+          # between Straddle and your systems.
+          external_id: nil,
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the account in a structured format.
+          metadata: nil,
+          correlation_id: nil,
+          request_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              access_level:
+                Straddle::Embed::AccountCreateParams::AccessLevel::OrSymbol,
+              account_type:
+                Straddle::Embed::AccountCreateParams::AccountType::OrSymbol,
+              business_profile: Straddle::Embed::BusinessProfileV1,
+              organization_id: String,
+              external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The access level granted to the account. This is determined by your platform
+        # configuration. Use `standard` unless instructed otherwise by Straddle.
+        module AccessLevel
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::AccountCreateParams::AccessLevel)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          STANDARD =
+            T.let(
+              :standard,
+              Straddle::Embed::AccountCreateParams::AccessLevel::TaggedSymbol
+            )
+          MANAGED =
+            T.let(
+              :managed,
+              Straddle::Embed::AccountCreateParams::AccessLevel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::AccountCreateParams::AccessLevel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The type of account to be created. Currently, only `business` is supported.
+        module AccountType
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::AccountCreateParams::AccountType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSINESS =
+            T.let(
+              :business,
+              Straddle::Embed::AccountCreateParams::AccountType::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              Straddle::Embed::AccountCreateParams::AccountType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::AccountCreateParams::AccountType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/account_get_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class AccountGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::AccountGetParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        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 do
+          params(
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(correlation_id: nil, request_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end