lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/events/subscription_update_params.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Events
+      class SubscriptionUpdateParams < Lithic::BaseModel
+        # @!parse
+        #   extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        # @!attribute url
+        #   URL to which event webhooks will be sent. URL must be a valid HTTPS address.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute [r] description
+        #   Event subscription description.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :description
+
+        # @!attribute [r] disabled
+        #   Whether the event subscription is active (false) or inactive (true).
+        #
+        #   @return [Boolean, nil]
+        optional :disabled, Lithic::BooleanModel
+
+        # @!parse
+        #   # @return [Boolean]
+        #   attr_writer :disabled
+
+        # @!attribute [r] event_types
+        #   Indicates types of events that will be sent to this subscription. If left blank,
+        #     all types will be sent.
+        #
+        #   @return [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>, nil]
+        optional :event_types,
+                 -> { Lithic::ArrayOf[enum: Lithic::Models::Events::SubscriptionUpdateParams::EventType] }
+
+        # @!parse
+        #   # @return [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>]
+        #   attr_writer :event_types
+
+        # @!parse
+        #   # @param url [String]
+        #   # @param description [String]
+        #   # @param disabled [Boolean]
+        #   # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>]
+        #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(url:, description: nil, disabled: nil, event_types: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+
+        module EventType
+          extend Lithic::Enum
+
+          ACCOUNT_HOLDER_CREATED = :"account_holder.created"
+          ACCOUNT_HOLDER_UPDATED = :"account_holder.updated"
+          ACCOUNT_HOLDER_VERIFICATION = :"account_holder.verification"
+          AUTH_RULES_PERFORMANCE_REPORT_CREATED = :"auth_rules.performance_report.created"
+          BALANCE_UPDATED = :"balance.updated"
+          BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
+          CARD_CREATED = :"card.created"
+          CARD_RENEWED = :"card.renewed"
+          CARD_REISSUED = :"card.reissued"
+          CARD_CONVERTED = :"card.converted"
+          CARD_SHIPPED = :"card.shipped"
+          CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
+          DIGITAL_WALLET_TOKENIZATION_APPROVAL_REQUEST = :"digital_wallet.tokenization_approval_request"
+          DIGITAL_WALLET_TOKENIZATION_RESULT = :"digital_wallet.tokenization_result"
+          DIGITAL_WALLET_TOKENIZATION_TWO_FACTOR_AUTHENTICATION_CODE =
+            :"digital_wallet.tokenization_two_factor_authentication_code"
+          DIGITAL_WALLET_TOKENIZATION_TWO_FACTOR_AUTHENTICATION_CODE_SENT =
+            :"digital_wallet.tokenization_two_factor_authentication_code_sent"
+          DIGITAL_WALLET_TOKENIZATION_UPDATED = :"digital_wallet.tokenization_updated"
+          DISPUTE_UPDATED = :"dispute.updated"
+          DISPUTE_EVIDENCE_UPLOAD_FAILED = :"dispute_evidence.upload_failed"
+          EXTERNAL_BANK_ACCOUNT_CREATED = :"external_bank_account.created"
+          EXTERNAL_BANK_ACCOUNT_UPDATED = :"external_bank_account.updated"
+          EXTERNAL_PAYMENT_CREATED = :"external_payment.created"
+          EXTERNAL_PAYMENT_UPDATED = :"external_payment.updated"
+          FINANCIAL_ACCOUNT_CREATED = :"financial_account.created"
+          FINANCIAL_ACCOUNT_UPDATED = :"financial_account.updated"
+          LOAN_TAPE_CREATED = :"loan_tape.created"
+          LOAN_TAPE_UPDATED = :"loan_tape.updated"
+          MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
+          MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
+          PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
+          PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
+          INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
+          INTERNAL_TRANSACTION_UPDATED = :"internal_transaction.updated"
+          SETTLEMENT_REPORT_UPDATED = :"settlement_report.updated"
+          STATEMENTS_CREATED = :"statements.created"
+          THREE_DS_AUTHENTICATION_CREATED = :"three_ds_authentication.created"
+          THREE_DS_AUTHENTICATION_UPDATED = :"three_ds_authentication.updated"
+          TOKENIZATION_APPROVAL_REQUEST = :"tokenization.approval_request"
+          TOKENIZATION_RESULT = :"tokenization.result"
+          TOKENIZATION_TWO_FACTOR_AUTHENTICATION_CODE = :"tokenization.two_factor_authentication_code"
+          TOKENIZATION_TWO_FACTOR_AUTHENTICATION_CODE_SENT = :"tokenization.two_factor_authentication_code_sent"
+          TOKENIZATION_UPDATED = :"tokenization.updated"
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/external_bank_account_address.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalBankAccountAddress < Lithic::BaseModel
+      # @!attribute address1
+      #
+      #   @return [String]
+      required :address1, String
+
+      # @!attribute city
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute postal_code
+      #
+      #   @return [String]
+      required :postal_code, String
+
+      # @!attribute state
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!attribute [r] address2
+      #
+      #   @return [String, nil]
+      optional :address2, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :address2
+
+      # @!parse
+      #   # @param address1 [String]
+      #   # @param city [String]
+      #   # @param country [String]
+      #   # @param postal_code [String]
+      #   # @param state [String]
+      #   # @param address2 [String]
+      #   #
+      #   def initialize(address1:, city:, country:, postal_code:, state:, address2: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/external_bank_account_create_params.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalBankAccountCreateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute account_number
+      #   Account Number
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute country
+      #   The country that the bank account is located in using ISO 3166-1. We will only
+      #     accept USA bank accounts e.g., USA
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute currency
+      #   currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute financial_account_token
+      #   The financial account token of the operating account to fund the micro deposits
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute owner
+      #   Legal Name of the business or individual who owns the external account. This
+      #     will appear in statements
+      #
+      #   @return [String]
+      required :owner, String
+
+      # @!attribute owner_type
+      #   Owner Type
+      #
+      #   @return [Symbol, Lithic::Models::OwnerType]
+      required :owner_type, enum: -> { Lithic::Models::OwnerType }
+
+      # @!attribute routing_number
+      #   Routing Number
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute type
+      #   Account Type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type]
+      required :type, enum: -> { Lithic::Models::ExternalBankAccountCreateParams::Type }
+
+      # @!attribute verification_method
+      #   Verification Method
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod]
+      required :verification_method,
+               enum: -> { Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod }
+
+      # @!attribute [r] account_token
+      #   Indicates which Lithic account the external account is associated with. For
+      #     external accounts that are associated with the program, account_token field
+      #     returned will be null
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :account_token
+
+      # @!attribute [r] address
+      #   Address
+      #
+      #   @return [Lithic::Models::ExternalBankAccountAddress, nil]
+      optional :address, -> { Lithic::Models::ExternalBankAccountAddress }
+
+      # @!parse
+      #   # @return [Lithic::Models::ExternalBankAccountAddress]
+      #   attr_writer :address
+
+      # @!attribute [r] company_id
+      #   Optional field that helps identify bank accounts in receipts
+      #
+      #   @return [String, nil]
+      optional :company_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :company_id
+
+      # @!attribute [r] dob
+      #   Date of Birth of the Individual that owns the external bank account
+      #
+      #   @return [Date, nil]
+      optional :dob, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :dob
+
+      # @!attribute [r] doing_business_as
+      #   Doing Business As
+      #
+      #   @return [String, nil]
+      optional :doing_business_as, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :doing_business_as
+
+      # @!attribute [r] name
+      #   The nickname for this External Bank Account
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :name
+
+      # @!attribute [r] user_defined_id
+      #   User Defined ID
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_defined_id
+
+      # @!attribute [r] verification_enforcement
+      #
+      #   @return [Boolean, nil]
+      optional :verification_enforcement, Lithic::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :verification_enforcement
+
+      # @!attribute processor_token
+      #
+      #   @return [String]
+      required :processor_token, String
+
+      # @!parse
+      #   # @param account_number [String]
+      #   # @param country [String]
+      #   # @param currency [String]
+      #   # @param financial_account_token [String]
+      #   # @param owner [String]
+      #   # @param owner_type [Symbol, Lithic::Models::OwnerType]
+      #   # @param routing_number [String]
+      #   # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type]
+      #   # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod]
+      #   # @param processor_token [String]
+      #   # @param account_token [String]
+      #   # @param address [Lithic::Models::ExternalBankAccountAddress]
+      #   # @param company_id [String]
+      #   # @param dob [Date]
+      #   # @param doing_business_as [String]
+      #   # @param name [String]
+      #   # @param user_defined_id [String]
+      #   # @param verification_enforcement [Boolean]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     account_number:,
+      #     country:,
+      #     currency:,
+      #     financial_account_token:,
+      #     owner:,
+      #     owner_type:,
+      #     routing_number:,
+      #     type:,
+      #     verification_method:,
+      #     processor_token:,
+      #     account_token: nil,
+      #     address: nil,
+      #     company_id: nil,
+      #     dob: nil,
+      #     doing_business_as: nil,
+      #     name: nil,
+      #     user_defined_id: nil,
+      #     verification_enforcement: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Account Type
+      module Type
+        extend Lithic::Enum
+
+        CHECKING = :CHECKING
+        SAVINGS = :SAVINGS
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Verification Method
+      module VerificationMethod
+        extend Lithic::Enum
+
+        EXTERNALLY_VERIFIED = :EXTERNALLY_VERIFIED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/external_bank_account_create_response.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalBankAccountCreateResponse < Lithic::BaseModel
+      # @!attribute token
+      #   A globally unique identifier for this record of an external bank account
+      #     association. If a program links an external bank account to more than one
+      #     end-user or to both the program and the end-user, then Lithic will return each
+      #     record of the association
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute country
+      #   The country that the bank account is located in using ISO 3166-1. We will only
+      #     accept USA bank accounts e.g., USA
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute created
+      #   An ISO 8601 string representing when this funding source was added to the Lithic
+      #     account.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute last_four
+      #   The last 4 digits of the bank account. Derived by Lithic from the account number
+      #     passed
+      #
+      #   @return [String]
+      required :last_four, String
+
+      # @!attribute owner
+      #   Legal Name of the business or individual who owns the external account. This
+      #     will appear in statements
+      #
+      #   @return [String]
+      required :owner, String
+
+      # @!attribute owner_type
+      #   Owner Type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::OwnerType]
+      required :owner_type, enum: -> { Lithic::Models::ExternalBankAccountCreateResponse::OwnerType }
+
+      # @!attribute routing_number
+      #   Routing Number
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute state
+      #   Account State
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::State]
+      required :state, enum: -> { Lithic::Models::ExternalBankAccountCreateResponse::State }
+
+      # @!attribute type
+      #   Account Type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::Type]
+      required :type, enum: -> { Lithic::Models::ExternalBankAccountCreateResponse::Type }
+
+      # @!attribute verification_attempts
+      #   The number of attempts at verification
+      #
+      #   @return [Integer]
+      required :verification_attempts, Integer
+
+      # @!attribute verification_method
+      #   Verification Method
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::VerificationMethod]
+      required :verification_method,
+               enum: -> { Lithic::Models::ExternalBankAccountCreateResponse::VerificationMethod }
+
+      # @!attribute verification_state
+      #   Verification State
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::VerificationState]
+      required :verification_state,
+               enum: -> { Lithic::Models::ExternalBankAccountCreateResponse::VerificationState }
+
+      # @!attribute [r] account_token
+      #   Indicates which Lithic account the external account is associated with. For
+      #     external accounts that are associated with the program, account_token field
+      #     returned will be null
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :account_token
+
+      # @!attribute [r] address
+      #   Address
+      #
+      #   @return [Lithic::Models::ExternalBankAccountAddress, nil]
+      optional :address, -> { Lithic::Models::ExternalBankAccountAddress }
+
+      # @!parse
+      #   # @return [Lithic::Models::ExternalBankAccountAddress]
+      #   attr_writer :address
+
+      # @!attribute [r] company_id
+      #   Optional field that helps identify bank accounts in receipts
+      #
+      #   @return [String, nil]
+      optional :company_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :company_id
+
+      # @!attribute [r] dob
+      #   Date of Birth of the Individual that owns the external bank account
+      #
+      #   @return [Date, nil]
+      optional :dob, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :dob
+
+      # @!attribute [r] doing_business_as
+      #   Doing Business As
+      #
+      #   @return [String, nil]
+      optional :doing_business_as, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :doing_business_as
+
+      # @!attribute [r] financial_account_token
+      #   The financial account token of the operating account to fund the micro deposits
+      #
+      #   @return [String, nil]
+      optional :financial_account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :financial_account_token
+
+      # @!attribute [r] name
+      #   The nickname for this External Bank Account
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :name
+
+      # @!attribute [r] user_defined_id
+      #   User Defined ID
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_defined_id
+
+      # @!attribute [r] verification_failed_reason
+      #   Optional free text description of the reason for the failed verification. For
+      #     ACH micro-deposits returned, this field will display the reason return code sent
+      #     by the ACH network
+      #
+      #   @return [String, nil]
+      optional :verification_failed_reason, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :verification_failed_reason
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param country [String]
+      #   # @param created [Time]
+      #   # @param currency [String]
+      #   # @param last_four [String]
+      #   # @param owner [String]
+      #   # @param owner_type [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::OwnerType]
+      #   # @param routing_number [String]
+      #   # @param state [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::State]
+      #   # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::Type]
+      #   # @param verification_attempts [Integer]
+      #   # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::VerificationMethod]
+      #   # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::VerificationState]
+      #   # @param account_token [String]
+      #   # @param address [Lithic::Models::ExternalBankAccountAddress]
+      #   # @param company_id [String]
+      #   # @param dob [Date]
+      #   # @param doing_business_as [String]
+      #   # @param financial_account_token [String]
+      #   # @param name [String]
+      #   # @param user_defined_id [String]
+      #   # @param verification_failed_reason [String]
+      #   #
+      #   def initialize(
+      #     token:,
+      #     country:,
+      #     created:,
+      #     currency:,
+      #     last_four:,
+      #     owner:,
+      #     owner_type:,
+      #     routing_number:,
+      #     state:,
+      #     type:,
+      #     verification_attempts:,
+      #     verification_method:,
+      #     verification_state:,
+      #     account_token: nil,
+      #     address: nil,
+      #     company_id: nil,
+      #     dob: nil,
+      #     doing_business_as: nil,
+      #     financial_account_token: nil,
+      #     name: nil,
+      #     user_defined_id: nil,
+      #     verification_failed_reason: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Owner Type
+      module OwnerType
+        extend Lithic::Enum
+
+        BUSINESS = :BUSINESS
+        INDIVIDUAL = :INDIVIDUAL
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Account State
+      module State
+        extend Lithic::Enum
+
+        ENABLED = :ENABLED
+        CLOSED = :CLOSED
+        PAUSED = :PAUSED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Account Type
+      module Type
+        extend Lithic::Enum
+
+        CHECKING = :CHECKING
+        SAVINGS = :SAVINGS
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Verification Method
+      module VerificationMethod
+        extend Lithic::Enum
+
+        MANUAL = :MANUAL
+        MICRO_DEPOSIT = :MICRO_DEPOSIT
+        PLAID = :PLAID
+        PRENOTE = :PRENOTE
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Verification State
+      module VerificationState
+        extend Lithic::Enum
+
+        PENDING = :PENDING
+        ENABLED = :ENABLED
+        FAILED_VERIFICATION = :FAILED_VERIFICATION
+        INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end