straddle 0.4.0 → 1.0.0

data/lib/straddle/models/customers/identity_verification_breakdown.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationBreakdown < Straddle::Internal::Type::BaseModel
+        # @!attribute codes
+        #   List of specific result codes from the fraud and risk screening.
+        #
+        #   @return [Array<String>, nil]
+        optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute correlation
+        #
+        #   @return [Symbol, Straddle::Models::Customers::CorrelationBucket, nil]
+        optional :correlation, enum: -> { Straddle::Customers::CorrelationBucket }
+
+        # @!attribute correlation_score
+        #   Represents the strength of the correlation between provided and known
+        #   information. A higher score indicates a stronger correlation.
+        #
+        #   @return [Float, nil]
+        optional :correlation_score, Float, nil?: true
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Customers::VerificationDecision, nil]
+        optional :decision, enum: -> { Straddle::Customers::VerificationDecision }
+
+        # @!attribute risk_score
+        #   Predicts the inherent risk associated with the customer for a given module. A
+        #   higher score indicates a greater likelihood of fraud.
+        #
+        #   @return [Float, nil]
+        optional :risk_score, Float, nil?: true
+
+        # @!method initialize(codes: nil, correlation: nil, correlation_score: nil, decision: nil, risk_score: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Customers::IdentityVerificationBreakdown} for more details.
+        #
+        #   @param codes [Array<String>, nil] List of specific result codes from the fraud and risk screening.
+        #
+        #   @param correlation [Symbol, Straddle::Models::Customers::CorrelationBucket]
+        #
+        #   @param correlation_score [Float, nil] Represents the strength of the correlation between provided and known informatio
+        #
+        #   @param decision [Symbol, Straddle::Models::Customers::VerificationDecision]
+        #
+        #   @param risk_score [Float, nil] Predicts the inherent risk associated with the customer for a given module. A hi
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/identity_verification_watchlist.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationWatchlist < Straddle::Internal::Type::BaseModel
+        # @!attribute codes
+        #   Result codes from Straddle watchlist screening.
+        #
+        #   @return [Array<String>, nil]
+        optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Customers::VerificationDecision, nil]
+        optional :decision, enum: -> { Straddle::Customers::VerificationDecision }
+
+        # @!attribute matched
+        #   Names of watchlists with matches.
+        #
+        #   @return [Array<String>, nil]
+        optional :matched, Straddle::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute matches
+        #   Details for matches found during watchlist screening.
+        #
+        #   @return [Array<Straddle::Models::Customers::IdentityVerificationWatchlistMatch>, nil]
+        optional :matches,
+                 -> do
+                   Straddle::Internal::Type::ArrayOf[Straddle::Customers::IdentityVerificationWatchlistMatch]
+                 end,
+                 nil?: true
+
+        # @!method initialize(codes: nil, decision: nil, matched: nil, matches: nil)
+        #   @param codes [Array<String>, nil] Result codes from Straddle watchlist screening.
+        #
+        #   @param decision [Symbol, Straddle::Models::Customers::VerificationDecision]
+        #
+        #   @param matched [Array<String>, nil] Names of watchlists with matches.
+        #
+        #   @param matches [Array<Straddle::Models::Customers::IdentityVerificationWatchlistMatch>, nil] Details for matches found during watchlist screening.
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/identity_verification_watchlist_match.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationWatchlistMatch < Straddle::Internal::Type::BaseModel
+        # @!attribute correlation
+        #
+        #   @return [Symbol, Straddle::Models::Customers::CorrelationBucket]
+        required :correlation, enum: -> { Straddle::Customers::CorrelationBucket }
+
+        # @!attribute list_name
+        #   Name of the watchlist that contains the matching record.
+        #
+        #   @return [String]
+        required :list_name, String
+
+        # @!attribute match_fields
+        #   Customer fields that match the watchlist record.
+        #
+        #   @return [Array<String>]
+        required :match_fields, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!attribute urls
+        #   Source URLs associated with the match.
+        #
+        #   @return [Array<String>]
+        required :urls, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(correlation:, list_name:, match_fields:, urls:)
+        #   @param correlation [Symbol, Straddle::Models::Customers::CorrelationBucket]
+        #
+        #   @param list_name [String] Name of the watchlist that contains the matching record.
+        #
+        #   @param match_fields [Array<String>] Customer fields that match the watchlist record.
+        #
+        #   @param urls [Array<String>] Source URLs associated with the match.
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/reputation_check.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class ReputationCheck < Straddle::Internal::Type::BaseModel
+        # @!attribute codes
+        #   Specific codes related to the Straddle reputation screening results.
+        #
+        #   @return [Array<String>, nil]
+        optional :codes, Straddle::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute decision
+        #
+        #   @return [Symbol, Straddle::Models::Customers::VerificationDecision, nil]
+        optional :decision, enum: -> { Straddle::Customers::VerificationDecision }
+
+        # @!attribute insights
+        #
+        #   @return [Straddle::Models::Customers::ReputationInsights, nil]
+        optional :insights, -> { Straddle::Customers::ReputationInsights }
+
+        # @!attribute risk_score
+        #   Risk score produced by the reputation check.
+        #
+        #   @return [Float, nil]
+        optional :risk_score, Float, nil?: true
+
+        # @!method initialize(codes: nil, decision: nil, insights: nil, risk_score: nil)
+        #   @param codes [Array<String>, nil] Specific codes related to the Straddle reputation screening results.
+        #
+        #   @param decision [Symbol, Straddle::Models::Customers::VerificationDecision]
+        #
+        #   @param insights [Straddle::Models::Customers::ReputationInsights]
+        #
+        #   @param risk_score [Float, nil] Risk score produced by the reputation check.
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/reputation_insights.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class ReputationInsights < Straddle::Internal::Type::BaseModel
+        # @!attribute accounts_active_count
+        #   Number of active accounts associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :accounts_active_count, Integer, nil?: true
+
+        # @!attribute accounts_closed_count
+        #   Number of closed accounts associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :accounts_closed_count, Integer, nil?: true
+
+        # @!attribute accounts_closed_dates
+        #   Dates when accounts associated with the identity were closed.
+        #
+        #   @return [Array<Date>, nil]
+        optional :accounts_closed_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute accounts_count
+        #   Number of accounts associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :accounts_count, Integer, nil?: true
+
+        # @!attribute accounts_fraud_count
+        #   Number of accounts associated with fraud.
+        #
+        #   @return [Integer, nil]
+        optional :accounts_fraud_count, Integer, nil?: true
+
+        # @!attribute accounts_fraud_labeled_dates
+        #   Dates when accounts were labeled as fraudulent.
+        #
+        #   @return [Array<Date>, nil]
+        optional :accounts_fraud_labeled_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute accounts_fraud_loss_total_amount
+        #   Total fraud loss associated with the accounts.
+        #
+        #   @return [Float, nil]
+        optional :accounts_fraud_loss_total_amount, Float, nil?: true
+
+        # @!attribute ach_fraud_transactions_count
+        #   Number of fraudulent ACH transactions.
+        #
+        #   @return [Integer, nil]
+        optional :ach_fraud_transactions_count, Integer, nil?: true
+
+        # @!attribute ach_fraud_transactions_dates
+        #   Dates when fraudulent ACH transactions occurred.
+        #
+        #   @return [Array<Date>, nil]
+        optional :ach_fraud_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute ach_fraud_transactions_total_amount
+        #   Total amount of fraudulent ACH transactions.
+        #
+        #   @return [Float, nil]
+        optional :ach_fraud_transactions_total_amount, Float, nil?: true
+
+        # @!attribute ach_returned_transactions_count
+        #   Number of returned ACH transactions.
+        #
+        #   @return [Integer, nil]
+        optional :ach_returned_transactions_count, Integer, nil?: true
+
+        # @!attribute ach_returned_transactions_dates
+        #   Dates when ACH transactions were returned.
+        #
+        #   @return [Array<Date>, nil]
+        optional :ach_returned_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute ach_returned_transactions_total_amount
+        #   Total amount of returned ACH transactions.
+        #
+        #   @return [Float, nil]
+        optional :ach_returned_transactions_total_amount, Float, nil?: true
+
+        # @!attribute applications_approved_count
+        #   Number of approved applications associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :applications_approved_count, Integer, nil?: true
+
+        # @!attribute applications_count
+        #   Number of applications associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :applications_count, Integer, nil?: true
+
+        # @!attribute applications_dates
+        #   Dates when applications associated with the identity were submitted.
+        #
+        #   @return [Array<Date>, nil]
+        optional :applications_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute applications_declined_count
+        #   Number of declined applications associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :applications_declined_count, Integer, nil?: true
+
+        # @!attribute applications_fraud_count
+        #   Number of applications associated with fraud.
+        #
+        #   @return [Integer, nil]
+        optional :applications_fraud_count, Integer, nil?: true
+
+        # @!attribute card_disputed_transactions_count
+        #   Number of disputed card transactions.
+        #
+        #   @return [Integer, nil]
+        optional :card_disputed_transactions_count, Integer, nil?: true
+
+        # @!attribute card_disputed_transactions_dates
+        #   Dates when card transactions were disputed.
+        #
+        #   @return [Array<Date>, nil]
+        optional :card_disputed_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute card_disputed_transactions_total_amount
+        #   Total amount of disputed card transactions.
+        #
+        #   @return [Float, nil]
+        optional :card_disputed_transactions_total_amount, Float, nil?: true
+
+        # @!attribute card_fraud_transactions_count
+        #   Number of fraudulent card transactions.
+        #
+        #   @return [Integer, nil]
+        optional :card_fraud_transactions_count, Integer, nil?: true
+
+        # @!attribute card_fraud_transactions_dates
+        #   Dates when fraudulent card transactions occurred.
+        #
+        #   @return [Array<Date>, nil]
+        optional :card_fraud_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute card_fraud_transactions_total_amount
+        #   Total amount of fraudulent card transactions.
+        #
+        #   @return [Float, nil]
+        optional :card_fraud_transactions_total_amount, Float, nil?: true
+
+        # @!attribute card_stopped_transactions_count
+        #   Number of stopped card transactions.
+        #
+        #   @return [Integer, nil]
+        optional :card_stopped_transactions_count, Integer, nil?: true
+
+        # @!attribute card_stopped_transactions_dates
+        #   Dates when card transactions were stopped.
+        #
+        #   @return [Array<Date>, nil]
+        optional :card_stopped_transactions_dates, Straddle::Internal::Type::ArrayOf[Date], nil?: true
+
+        # @!attribute user_active_profile_count
+        #   Number of active profiles associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_active_profile_count, Integer, nil?: true
+
+        # @!attribute user_address_count
+        #   Number of addresses associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_address_count, Integer, nil?: true
+
+        # @!attribute user_closed_profile_count
+        #   Number of closed profiles associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_closed_profile_count, Integer, nil?: true
+
+        # @!attribute user_dob_count
+        #   Number of dates of birth associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_dob_count, Integer, nil?: true
+
+        # @!attribute user_email_count
+        #   Number of email addresses associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_email_count, Integer, nil?: true
+
+        # @!attribute user_institution_count
+        #   Number of financial institutions associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_institution_count, Integer, nil?: true
+
+        # @!attribute user_mobile_count
+        #   Number of mobile numbers associated with the identity.
+        #
+        #   @return [Integer, nil]
+        optional :user_mobile_count, Integer, nil?: true
+
+        # @!method initialize(accounts_active_count: nil, accounts_closed_count: nil, accounts_closed_dates: nil, accounts_count: nil, accounts_fraud_count: nil, accounts_fraud_labeled_dates: nil, accounts_fraud_loss_total_amount: nil, ach_fraud_transactions_count: nil, ach_fraud_transactions_dates: nil, ach_fraud_transactions_total_amount: nil, ach_returned_transactions_count: nil, ach_returned_transactions_dates: nil, ach_returned_transactions_total_amount: nil, applications_approved_count: nil, applications_count: nil, applications_dates: nil, applications_declined_count: nil, applications_fraud_count: nil, card_disputed_transactions_count: nil, card_disputed_transactions_dates: nil, card_disputed_transactions_total_amount: nil, card_fraud_transactions_count: nil, card_fraud_transactions_dates: nil, card_fraud_transactions_total_amount: nil, card_stopped_transactions_count: nil, card_stopped_transactions_dates: nil, user_active_profile_count: nil, user_address_count: nil, user_closed_profile_count: nil, user_dob_count: nil, user_email_count: nil, user_institution_count: nil, user_mobile_count: nil)
+        #   @param accounts_active_count [Integer, nil] Number of active accounts associated with the identity.
+        #
+        #   @param accounts_closed_count [Integer, nil] Number of closed accounts associated with the identity.
+        #
+        #   @param accounts_closed_dates [Array<Date>, nil] Dates when accounts associated with the identity were closed.
+        #
+        #   @param accounts_count [Integer, nil] Number of accounts associated with the identity.
+        #
+        #   @param accounts_fraud_count [Integer, nil] Number of accounts associated with fraud.
+        #
+        #   @param accounts_fraud_labeled_dates [Array<Date>, nil] Dates when accounts were labeled as fraudulent.
+        #
+        #   @param accounts_fraud_loss_total_amount [Float, nil] Total fraud loss associated with the accounts.
+        #
+        #   @param ach_fraud_transactions_count [Integer, nil] Number of fraudulent ACH transactions.
+        #
+        #   @param ach_fraud_transactions_dates [Array<Date>, nil] Dates when fraudulent ACH transactions occurred.
+        #
+        #   @param ach_fraud_transactions_total_amount [Float, nil] Total amount of fraudulent ACH transactions.
+        #
+        #   @param ach_returned_transactions_count [Integer, nil] Number of returned ACH transactions.
+        #
+        #   @param ach_returned_transactions_dates [Array<Date>, nil] Dates when ACH transactions were returned.
+        #
+        #   @param ach_returned_transactions_total_amount [Float, nil] Total amount of returned ACH transactions.
+        #
+        #   @param applications_approved_count [Integer, nil] Number of approved applications associated with the identity.
+        #
+        #   @param applications_count [Integer, nil] Number of applications associated with the identity.
+        #
+        #   @param applications_dates [Array<Date>, nil] Dates when applications associated with the identity were submitted.
+        #
+        #   @param applications_declined_count [Integer, nil] Number of declined applications associated with the identity.
+        #
+        #   @param applications_fraud_count [Integer, nil] Number of applications associated with fraud.
+        #
+        #   @param card_disputed_transactions_count [Integer, nil] Number of disputed card transactions.
+        #
+        #   @param card_disputed_transactions_dates [Array<Date>, nil] Dates when card transactions were disputed.
+        #
+        #   @param card_disputed_transactions_total_amount [Float, nil] Total amount of disputed card transactions.
+        #
+        #   @param card_fraud_transactions_count [Integer, nil] Number of fraudulent card transactions.
+        #
+        #   @param card_fraud_transactions_dates [Array<Date>, nil] Dates when fraudulent card transactions occurred.
+        #
+        #   @param card_fraud_transactions_total_amount [Float, nil] Total amount of fraudulent card transactions.
+        #
+        #   @param card_stopped_transactions_count [Integer, nil] Number of stopped card transactions.
+        #
+        #   @param card_stopped_transactions_dates [Array<Date>, nil] Dates when card transactions were stopped.
+        #
+        #   @param user_active_profile_count [Integer, nil] Number of active profiles associated with the identity.
+        #
+        #   @param user_address_count [Integer, nil] Number of addresses associated with the identity.
+        #
+        #   @param user_closed_profile_count [Integer, nil] Number of closed profiles associated with the identity.
+        #
+        #   @param user_dob_count [Integer, nil] Number of dates of birth associated with the identity.
+        #
+        #   @param user_email_count [Integer, nil] Number of email addresses associated with the identity.
+        #
+        #   @param user_institution_count [Integer, nil] Number of financial institutions associated with the identity.
+        #
+        #   @param user_mobile_count [Integer, nil] Number of mobile numbers associated with the identity.
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/review_list_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      # @see Straddle::Resources::Customers::Review#list
+      class ReviewListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute correlation_id
+        #   Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #   Optional client-generated identifier for tracing one request.
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #   For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(id:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @param request_id [String] Optional client-generated identifier for tracing one request.
+        #
+        #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/review_set_verification_decision_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      # @see Straddle::Resources::Customers::Review#set_verification_decision
+      class ReviewSetVerificationDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The final status of the customer review.
+        #
+        #   @return [Symbol, Straddle::Models::Customers::ReviewSetVerificationDecisionParams::Status]
+        required :status, enum: -> { Straddle::Customers::ReviewSetVerificationDecisionParams::Status }
+
+        # @!attribute correlation_id
+        #   Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute idempotency_key
+        #   Optional client-generated key for an idempotent request.
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute request_id
+        #   Optional client-generated identifier for tracing one request.
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #   For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(id:, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param status [Symbol, Straddle::Models::Customers::ReviewSetVerificationDecisionParams::Status] The final status of the customer review.
+        #
+        #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+        #
+        #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+        #
+        #   @param request_id [String] Optional client-generated identifier for tracing one request.
+        #
+        #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        # The final status of the customer review.
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          VERIFIED = :verified
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/customers/verification_decision.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      module VerificationDecision
+        extend Straddle::Internal::Type::Enum
+
+        ACCEPT = :accept
+        REJECT = :reject
+        REVIEW = :review
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end