straddle 0.1.0.pre.alpha.1

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      class IdentityVerificationBreakdownV1 < 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::IdentityVerificationBreakdownV1::Correlation, nil]
+        optional :correlation, enum: -> { Straddle::Customers::IdentityVerificationBreakdownV1::Correlation }
+
+        # @!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::IdentityVerificationBreakdownV1::Decision, nil]
+        optional :decision, enum: -> { Straddle::Customers::IdentityVerificationBreakdownV1::Decision }
+
+        # @!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::IdentityVerificationBreakdownV1} 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::IdentityVerificationBreakdownV1::Correlation]
+        #
+        #   @param correlation_score [Float, nil] Represents the strength of the correlation between provided and known informatio
+        #
+        #   @param decision [Symbol, Straddle::Models::Customers::IdentityVerificationBreakdownV1::Decision]
+        #
+        #   @param risk_score [Float, nil] Predicts the inherent risk associated with the customer for a given module. A hi
+
+        # @see Straddle::Models::Customers::IdentityVerificationBreakdownV1#correlation
+        module Correlation
+          extend Straddle::Internal::Type::Enum
+
+          LOW_CONFIDENCE = :low_confidence
+          POTENTIAL_MATCH = :potential_match
+          LIKELY_MATCH = :likely_match
+          HIGH_CONFIDENCE = :high_confidence
+          UNKNOWN = :unknown
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Straddle::Models::Customers::IdentityVerificationBreakdownV1#decision
+        module Decision
+          extend Straddle::Internal::Type::Enum
+
+          ACCEPT = :accept
+          REJECT = :reject
+          REVIEW = :review
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      # @see Straddle::Resources::Customers::Review#decision
+      class ReviewDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute status
+        #   The final status of the customer review.
+        #
+        #   @return [Symbol, Straddle::Models::Customers::ReviewDecisionParams::Status]
+        required :status, enum: -> { Straddle::Customers::ReviewDecisionParams::Status }
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(status:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param status [Symbol, Straddle::Models::Customers::ReviewDecisionParams::Status] The final status of the customer review.
+        #
+        #   @param correlation_id [String]
+        #
+        #   @param request_id [String]
+        #
+        #   @param straddle_account_id [String]
+        #
+        #   @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/review_get_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Customers
+      # @see Straddle::Resources::Customers::Review#get
+      class ReviewGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute straddle_account_id
+        #
+        #   @return [String, nil]
+        optional :straddle_account_id, String
+
+        # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+        #   @param correlation_id [String]
+        #   @param request_id [String]
+        #   @param straddle_account_id [String]
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/straddle/models/device_info_v1.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class DeviceInfoV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute ip_address
+      #   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.
+      #
+      #   @return [String]
+      required :ip_address, String
+
+      # @!method initialize(ip_address:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::DeviceInfoV1} for more details.
+      #
+      #   @param ip_address [String] The IP address of the device used when the customer authorized the charge or pay
+    end
+  end
+end

data/lib/straddle/models/device_unmasked_v1.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class DeviceUnmaskedV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute ip_address
+      #   The customer's IP address at the time of profile creation. Use `0.0.0.0` to
+      #   represent an offline customer registration.
+      #
+      #   @return [String]
+      required :ip_address, String
+
+      # @!method initialize(ip_address:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::DeviceUnmaskedV1} for more details.
+      #
+      #   @param ip_address [String] The customer's IP address at the time of profile creation. Use `0.0.0.0` to repr
+    end
+  end
+end

data/lib/straddle/models/embed/account_create_params.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::Accounts#create
+      class AccountCreateParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute access_level
+        #   The access level granted to the account. This is determined by your platform
+        #   configuration. Use `standard` unless instructed otherwise by Straddle.
+        #
+        #   @return [Symbol, Straddle::Models::Embed::AccountCreateParams::AccessLevel]
+        required :access_level, enum: -> { Straddle::Embed::AccountCreateParams::AccessLevel }
+
+        # @!attribute account_type
+        #   The type of account to be created. Currently, only `business` is supported.
+        #
+        #   @return [Symbol, Straddle::Models::Embed::AccountCreateParams::AccountType]
+        required :account_type, enum: -> { Straddle::Embed::AccountCreateParams::AccountType }
+
+        # @!attribute business_profile
+        #
+        #   @return [Straddle::Models::Embed::BusinessProfileV1]
+        required :business_profile, -> { Straddle::Embed::BusinessProfileV1 }
+
+        # @!attribute organization_id
+        #   The unique identifier of the organization related to this account.
+        #
+        #   @return [String]
+        required :organization_id, String
+
+        # @!attribute external_id
+        #   Unique identifier for the account in your database, used for cross-referencing
+        #   between Straddle and your systems.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
+        # @!attribute metadata
+        #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        #   information about the account in a structured format.
+        #
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(access_level:, account_type:, business_profile:, organization_id:, external_id: nil, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::AccountCreateParams} for more details.
+        #
+        #   @param access_level [Symbol, Straddle::Models::Embed::AccountCreateParams::AccessLevel] The access level granted to the account. This is determined by your platform con
+        #
+        #   @param account_type [Symbol, Straddle::Models::Embed::AccountCreateParams::AccountType] The type of account to be created. Currently, only `business` is supported.
+        #
+        #   @param business_profile [Straddle::Models::Embed::BusinessProfileV1]
+        #
+        #   @param organization_id [String] The unique identifier of the organization related to this account.
+        #
+        #   @param external_id [String, nil] Unique identifier for the account in your database, used for cross-referencing b
+        #
+        #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
+        #
+        #   @param correlation_id [String]
+        #
+        #   @param request_id [String]
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        # 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
+
+          STANDARD = :standard
+          MANAGED = :managed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The type of account to be created. Currently, only `business` is supported.
+        module AccountType
+          extend Straddle::Internal::Type::Enum
+
+          BUSINESS = :business
+          UNKNOWN = :unknown
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/embed/account_get_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::Accounts#get
+      class AccountGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        #   @param correlation_id [String]
+        #   @param request_id [String]
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/straddle/models/embed/account_list_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::Accounts#list
+      class AccountListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute page_number
+        #   Results page number. Starts at page 1. Default value: 1
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Page size. Default value: 100. Max value: 1000
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute search_text
+        #
+        #   @return [String, nil]
+        optional :search_text, String
+
+        # @!attribute sort_by
+        #   Sort By. Default value: 'id'.
+        #
+        #   @return [String, nil]
+        optional :sort_by, String
+
+        # @!attribute sort_order
+        #   Sort Order. Default value: 'asc'.
+        #
+        #   @return [Symbol, Straddle::Models::Embed::AccountListParams::SortOrder, nil]
+        optional :sort_order, enum: -> { Straddle::Embed::AccountListParams::SortOrder }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Straddle::Models::Embed::AccountListParams::Status, nil]
+        optional :status, enum: -> { Straddle::Embed::AccountListParams::Status }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Straddle::Models::Embed::AccountListParams::Type, nil]
+        optional :type, enum: -> { Straddle::Embed::AccountListParams::Type }
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param page_number [Integer] Results page number. Starts at page 1. Default value: 1
+        #
+        #   @param page_size [Integer] Page size. Default value: 100. Max value: 1000
+        #
+        #   @param search_text [String]
+        #
+        #   @param sort_by [String] Sort By. Default value: 'id'.
+        #
+        #   @param sort_order [Symbol, Straddle::Models::Embed::AccountListParams::SortOrder] Sort Order. Default value: 'asc'.
+        #
+        #   @param status [Symbol, Straddle::Models::Embed::AccountListParams::Status]
+        #
+        #   @param type [Symbol, Straddle::Models::Embed::AccountListParams::Type]
+        #
+        #   @param correlation_id [String]
+        #
+        #   @param request_id [String]
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        # Sort Order. Default value: 'asc'.
+        module SortOrder
+          extend Straddle::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          CREATED = :created
+          ONBOARDING = :onboarding
+          ACTIVE = :active
+          REJECTED = :rejected
+          INACTIVE = :inactive
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Type
+          extend Straddle::Internal::Type::Enum
+
+          BUSINESS = :business
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/embed/account_onboard_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::Accounts#onboard
+      class AccountOnboardParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute terms_of_service
+        #
+        #   @return [Straddle::Models::Embed::TermsOfServiceV1]
+        required :terms_of_service, -> { Straddle::Embed::TermsOfServiceV1 }
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(terms_of_service:, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param terms_of_service [Straddle::Models::Embed::TermsOfServiceV1]
+        #   @param correlation_id [String]
+        #   @param request_id [String]
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end