straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/customers/identity_verification_alerts.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationAlerts < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::IdentityVerificationAlerts,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Any alerts or flags raised during the consortium alert screening.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :alerts
+
+        # List of specific result codes from the consortium alert screening.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :codes
+
+        sig do
+          returns(
+            T.nilable(Straddle::Customers::VerificationDecision::TaggedSymbol)
+          )
+        end
+        attr_reader :decision
+
+        sig do
+          params(
+            decision: Straddle::Customers::VerificationDecision::OrSymbol
+          ).void
+        end
+        attr_writer :decision
+
+        sig do
+          params(
+            alerts: T.nilable(T::Array[String]),
+            codes: T.nilable(T::Array[String]),
+            decision: Straddle::Customers::VerificationDecision::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Any alerts or flags raised during the consortium alert screening.
+          alerts: nil,
+          # List of specific result codes from the consortium alert screening.
+          codes: nil,
+          decision: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              alerts: T.nilable(T::Array[String]),
+              codes: T.nilable(T::Array[String]),
+              decision: Straddle::Customers::VerificationDecision::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/identity_verification_breakdown.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationBreakdown < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::IdentityVerificationBreakdown,
+              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::CorrelationBucket::TaggedSymbol)
+          )
+        end
+        attr_reader :correlation
+
+        sig do
+          params(
+            correlation: Straddle::Customers::CorrelationBucket::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::VerificationDecision::TaggedSymbol)
+          )
+        end
+        attr_reader :decision
+
+        sig do
+          params(
+            decision: Straddle::Customers::VerificationDecision::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::CorrelationBucket::OrSymbol,
+            correlation_score: T.nilable(Float),
+            decision: Straddle::Customers::VerificationDecision::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::CorrelationBucket::TaggedSymbol,
+              correlation_score: T.nilable(Float),
+              decision: Straddle::Customers::VerificationDecision::TaggedSymbol,
+              risk_score: T.nilable(Float)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/identity_verification_watchlist.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationWatchlist < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::IdentityVerificationWatchlist,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Result codes from Straddle watchlist screening.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :codes
+
+        sig do
+          returns(
+            T.nilable(Straddle::Customers::VerificationDecision::TaggedSymbol)
+          )
+        end
+        attr_reader :decision
+
+        sig do
+          params(
+            decision: Straddle::Customers::VerificationDecision::OrSymbol
+          ).void
+        end
+        attr_writer :decision
+
+        # Names of watchlists with matches.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :matched
+
+        # Details for matches found during watchlist screening.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Straddle::Customers::IdentityVerificationWatchlistMatch]
+            )
+          )
+        end
+        attr_accessor :matches
+
+        sig do
+          params(
+            codes: T.nilable(T::Array[String]),
+            decision: Straddle::Customers::VerificationDecision::OrSymbol,
+            matched: T.nilable(T::Array[String]),
+            matches:
+              T.nilable(
+                T::Array[
+                  Straddle::Customers::IdentityVerificationWatchlistMatch::OrHash
+                ]
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Result codes from Straddle watchlist screening.
+          codes: nil,
+          decision: nil,
+          # Names of watchlists with matches.
+          matched: nil,
+          # Details for matches found during watchlist screening.
+          matches: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              codes: T.nilable(T::Array[String]),
+              decision: Straddle::Customers::VerificationDecision::TaggedSymbol,
+              matched: T.nilable(T::Array[String]),
+              matches:
+                T.nilable(
+                  T::Array[
+                    Straddle::Customers::IdentityVerificationWatchlistMatch
+                  ]
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/identity_verification_watchlist_match.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationWatchlistMatch < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::IdentityVerificationWatchlistMatch,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Straddle::Customers::CorrelationBucket::TaggedSymbol) }
+        attr_accessor :correlation
+
+        # Name of the watchlist that contains the matching record.
+        sig { returns(String) }
+        attr_accessor :list_name
+
+        # Customer fields that match the watchlist record.
+        sig { returns(T::Array[String]) }
+        attr_accessor :match_fields
+
+        # Source URLs associated with the match.
+        sig { returns(T::Array[String]) }
+        attr_accessor :urls
+
+        sig do
+          params(
+            correlation: Straddle::Customers::CorrelationBucket::OrSymbol,
+            list_name: String,
+            match_fields: T::Array[String],
+            urls: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          correlation:,
+          # Name of the watchlist that contains the matching record.
+          list_name:,
+          # Customer fields that match the watchlist record.
+          match_fields:,
+          # Source URLs associated with the match.
+          urls:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              correlation: Straddle::Customers::CorrelationBucket::TaggedSymbol,
+              list_name: String,
+              match_fields: T::Array[String],
+              urls: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/reputation_check.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReputationCheck < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReputationCheck,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Specific codes related to the Straddle reputation screening results.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :codes
+
+        sig do
+          returns(
+            T.nilable(Straddle::Customers::VerificationDecision::TaggedSymbol)
+          )
+        end
+        attr_reader :decision
+
+        sig do
+          params(
+            decision: Straddle::Customers::VerificationDecision::OrSymbol
+          ).void
+        end
+        attr_writer :decision
+
+        sig { returns(T.nilable(Straddle::Customers::ReputationInsights)) }
+        attr_reader :insights
+
+        sig do
+          params(insights: Straddle::Customers::ReputationInsights::OrHash).void
+        end
+        attr_writer :insights
+
+        # Risk score produced by the reputation check.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :risk_score
+
+        sig do
+          params(
+            codes: T.nilable(T::Array[String]),
+            decision: Straddle::Customers::VerificationDecision::OrSymbol,
+            insights: Straddle::Customers::ReputationInsights::OrHash,
+            risk_score: T.nilable(Float)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Specific codes related to the Straddle reputation screening results.
+          codes: nil,
+          decision: nil,
+          insights: nil,
+          # Risk score produced by the reputation check.
+          risk_score: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              codes: T.nilable(T::Array[String]),
+              decision: Straddle::Customers::VerificationDecision::TaggedSymbol,
+              insights: Straddle::Customers::ReputationInsights,
+              risk_score: T.nilable(Float)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/customers/reputation_insights.rbi

@@ -0,0 +1,298 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Customers
+      class ReputationInsights < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Customers::ReputationInsights,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # Number of active accounts associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :accounts_active_count
+
+        # Number of closed accounts associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :accounts_closed_count
+
+        # Dates when accounts associated with the identity were closed.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :accounts_closed_dates
+
+        # Number of accounts associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :accounts_count
+
+        # Number of accounts associated with fraud.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :accounts_fraud_count
+
+        # Dates when accounts were labeled as fraudulent.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :accounts_fraud_labeled_dates
+
+        # Total fraud loss associated with the accounts.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :accounts_fraud_loss_total_amount
+
+        # Number of fraudulent ACH transactions.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :ach_fraud_transactions_count
+
+        # Dates when fraudulent ACH transactions occurred.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :ach_fraud_transactions_dates
+
+        # Total amount of fraudulent ACH transactions.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :ach_fraud_transactions_total_amount
+
+        # Number of returned ACH transactions.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :ach_returned_transactions_count
+
+        # Dates when ACH transactions were returned.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :ach_returned_transactions_dates
+
+        # Total amount of returned ACH transactions.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :ach_returned_transactions_total_amount
+
+        # Number of approved applications associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :applications_approved_count
+
+        # Number of applications associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :applications_count
+
+        # Dates when applications associated with the identity were submitted.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :applications_dates
+
+        # Number of declined applications associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :applications_declined_count
+
+        # Number of applications associated with fraud.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :applications_fraud_count
+
+        # Number of disputed card transactions.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :card_disputed_transactions_count
+
+        # Dates when card transactions were disputed.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :card_disputed_transactions_dates
+
+        # Total amount of disputed card transactions.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :card_disputed_transactions_total_amount
+
+        # Number of fraudulent card transactions.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :card_fraud_transactions_count
+
+        # Dates when fraudulent card transactions occurred.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :card_fraud_transactions_dates
+
+        # Total amount of fraudulent card transactions.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :card_fraud_transactions_total_amount
+
+        # Number of stopped card transactions.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :card_stopped_transactions_count
+
+        # Dates when card transactions were stopped.
+        sig { returns(T.nilable(T::Array[Date])) }
+        attr_accessor :card_stopped_transactions_dates
+
+        # Number of active profiles associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_active_profile_count
+
+        # Number of addresses associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_address_count
+
+        # Number of closed profiles associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_closed_profile_count
+
+        # Number of dates of birth associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_dob_count
+
+        # Number of email addresses associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_email_count
+
+        # Number of financial institutions associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_institution_count
+
+        # Number of mobile numbers associated with the identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :user_mobile_count
+
+        sig do
+          params(
+            accounts_active_count: T.nilable(Integer),
+            accounts_closed_count: T.nilable(Integer),
+            accounts_closed_dates: T.nilable(T::Array[Date]),
+            accounts_count: T.nilable(Integer),
+            accounts_fraud_count: T.nilable(Integer),
+            accounts_fraud_labeled_dates: T.nilable(T::Array[Date]),
+            accounts_fraud_loss_total_amount: T.nilable(Float),
+            ach_fraud_transactions_count: T.nilable(Integer),
+            ach_fraud_transactions_dates: T.nilable(T::Array[Date]),
+            ach_fraud_transactions_total_amount: T.nilable(Float),
+            ach_returned_transactions_count: T.nilable(Integer),
+            ach_returned_transactions_dates: T.nilable(T::Array[Date]),
+            ach_returned_transactions_total_amount: T.nilable(Float),
+            applications_approved_count: T.nilable(Integer),
+            applications_count: T.nilable(Integer),
+            applications_dates: T.nilable(T::Array[Date]),
+            applications_declined_count: T.nilable(Integer),
+            applications_fraud_count: T.nilable(Integer),
+            card_disputed_transactions_count: T.nilable(Integer),
+            card_disputed_transactions_dates: T.nilable(T::Array[Date]),
+            card_disputed_transactions_total_amount: T.nilable(Float),
+            card_fraud_transactions_count: T.nilable(Integer),
+            card_fraud_transactions_dates: T.nilable(T::Array[Date]),
+            card_fraud_transactions_total_amount: T.nilable(Float),
+            card_stopped_transactions_count: T.nilable(Integer),
+            card_stopped_transactions_dates: T.nilable(T::Array[Date]),
+            user_active_profile_count: T.nilable(Integer),
+            user_address_count: T.nilable(Integer),
+            user_closed_profile_count: T.nilable(Integer),
+            user_dob_count: T.nilable(Integer),
+            user_email_count: T.nilable(Integer),
+            user_institution_count: T.nilable(Integer),
+            user_mobile_count: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of active accounts associated with the identity.
+          accounts_active_count: nil,
+          # Number of closed accounts associated with the identity.
+          accounts_closed_count: nil,
+          # Dates when accounts associated with the identity were closed.
+          accounts_closed_dates: nil,
+          # Number of accounts associated with the identity.
+          accounts_count: nil,
+          # Number of accounts associated with fraud.
+          accounts_fraud_count: nil,
+          # Dates when accounts were labeled as fraudulent.
+          accounts_fraud_labeled_dates: nil,
+          # Total fraud loss associated with the accounts.
+          accounts_fraud_loss_total_amount: nil,
+          # Number of fraudulent ACH transactions.
+          ach_fraud_transactions_count: nil,
+          # Dates when fraudulent ACH transactions occurred.
+          ach_fraud_transactions_dates: nil,
+          # Total amount of fraudulent ACH transactions.
+          ach_fraud_transactions_total_amount: nil,
+          # Number of returned ACH transactions.
+          ach_returned_transactions_count: nil,
+          # Dates when ACH transactions were returned.
+          ach_returned_transactions_dates: nil,
+          # Total amount of returned ACH transactions.
+          ach_returned_transactions_total_amount: nil,
+          # Number of approved applications associated with the identity.
+          applications_approved_count: nil,
+          # Number of applications associated with the identity.
+          applications_count: nil,
+          # Dates when applications associated with the identity were submitted.
+          applications_dates: nil,
+          # Number of declined applications associated with the identity.
+          applications_declined_count: nil,
+          # Number of applications associated with fraud.
+          applications_fraud_count: nil,
+          # Number of disputed card transactions.
+          card_disputed_transactions_count: nil,
+          # Dates when card transactions were disputed.
+          card_disputed_transactions_dates: nil,
+          # Total amount of disputed card transactions.
+          card_disputed_transactions_total_amount: nil,
+          # Number of fraudulent card transactions.
+          card_fraud_transactions_count: nil,
+          # Dates when fraudulent card transactions occurred.
+          card_fraud_transactions_dates: nil,
+          # Total amount of fraudulent card transactions.
+          card_fraud_transactions_total_amount: nil,
+          # Number of stopped card transactions.
+          card_stopped_transactions_count: nil,
+          # Dates when card transactions were stopped.
+          card_stopped_transactions_dates: nil,
+          # Number of active profiles associated with the identity.
+          user_active_profile_count: nil,
+          # Number of addresses associated with the identity.
+          user_address_count: nil,
+          # Number of closed profiles associated with the identity.
+          user_closed_profile_count: nil,
+          # Number of dates of birth associated with the identity.
+          user_dob_count: nil,
+          # Number of email addresses associated with the identity.
+          user_email_count: nil,
+          # Number of financial institutions associated with the identity.
+          user_institution_count: nil,
+          # Number of mobile numbers associated with the identity.
+          user_mobile_count: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              accounts_active_count: T.nilable(Integer),
+              accounts_closed_count: T.nilable(Integer),
+              accounts_closed_dates: T.nilable(T::Array[Date]),
+              accounts_count: T.nilable(Integer),
+              accounts_fraud_count: T.nilable(Integer),
+              accounts_fraud_labeled_dates: T.nilable(T::Array[Date]),
+              accounts_fraud_loss_total_amount: T.nilable(Float),
+              ach_fraud_transactions_count: T.nilable(Integer),
+              ach_fraud_transactions_dates: T.nilable(T::Array[Date]),
+              ach_fraud_transactions_total_amount: T.nilable(Float),
+              ach_returned_transactions_count: T.nilable(Integer),
+              ach_returned_transactions_dates: T.nilable(T::Array[Date]),
+              ach_returned_transactions_total_amount: T.nilable(Float),
+              applications_approved_count: T.nilable(Integer),
+              applications_count: T.nilable(Integer),
+              applications_dates: T.nilable(T::Array[Date]),
+              applications_declined_count: T.nilable(Integer),
+              applications_fraud_count: T.nilable(Integer),
+              card_disputed_transactions_count: T.nilable(Integer),
+              card_disputed_transactions_dates: T.nilable(T::Array[Date]),
+              card_disputed_transactions_total_amount: T.nilable(Float),
+              card_fraud_transactions_count: T.nilable(Integer),
+              card_fraud_transactions_dates: T.nilable(T::Array[Date]),
+              card_fraud_transactions_total_amount: T.nilable(Float),
+              card_stopped_transactions_count: T.nilable(Integer),
+              card_stopped_transactions_dates: T.nilable(T::Array[Date]),
+              user_active_profile_count: T.nilable(Integer),
+              user_address_count: T.nilable(Integer),
+              user_closed_profile_count: T.nilable(Integer),
+              user_dob_count: T.nilable(Integer),
+              user_email_count: T.nilable(Integer),
+              user_institution_count: T.nilable(Integer),
+              user_mobile_count: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end