modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/ledgerable_event.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @deprecated
+    class LedgerableEvent < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute custom_data
+      #   Additionally data to be used by the Ledger Event Handler.
+      #
+      #   @return [Object, nil]
+      required :custom_data, ModernTreasury::Unknown, nil?: true
+
+      # @!attribute description
+      #   Description of the ledgerable event.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute ledger_event_handler_id
+      #   Id of the ledger event handler that is used to create a ledger transaction.
+      #
+      #   @return [String]
+      required :ledger_event_handler_id, String
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #     if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      required :metadata, ModernTreasury::HashOf[String], nil?: true
+
+      # @!attribute name
+      #   Name of the ledgerable event.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param custom_data [Object, nil]
+      #   # @param description [String, nil]
+      #   # @param ledger_event_handler_id [String]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}, nil]
+      #   # @param name [String]
+      #   # @param object [String]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     custom_data:,
+      #     description:,
+      #     ledger_event_handler_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     name:,
+      #     object:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_event_create_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerableEventCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute name
+      #   Name of the ledgerable event.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute custom_data
+      #   Additionally data to be used by the Ledger Event Handler.
+      #
+      #   @return [Object, nil]
+      optional :custom_data, ModernTreasury::Unknown, nil?: true
+
+      # @!attribute description
+      #   Description of the ledgerable event.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!parse
+      #   # @param name [String]
+      #   # @param custom_data [Object, nil]
+      #   # @param description [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(name:, custom_data: nil, description: nil, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerableEventRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/legal_entity.rb

@@ -0,0 +1,544 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LegalEntity < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute addresses
+      #   A list of addresses for the entity.
+      #
+      #   @return [Array<ModernTreasury::Models::LegalEntity::Address>]
+      required :addresses, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::Address] }
+
+      # @!attribute bank_settings
+      #
+      #   @return [ModernTreasury::Models::BankSettings, nil]
+      required :bank_settings, -> { ModernTreasury::Models::BankSettings }, nil?: true
+
+      # @!attribute business_name
+      #   The business's legal business name.
+      #
+      #   @return [String, nil]
+      required :business_name, String, nil?: true
+
+      # @!attribute citizenship_country
+      #   The country of citizenship for an individual.
+      #
+      #   @return [String, nil]
+      required :citizenship_country, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute date_formed
+      #   A business's formation date (YYYY-MM-DD).
+      #
+      #   @return [Date, nil]
+      required :date_formed, Date, nil?: true
+
+      # @!attribute date_of_birth
+      #   An individual's date of birth (YYYY-MM-DD).
+      #
+      #   @return [Date, nil]
+      required :date_of_birth, Date, nil?: true
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute doing_business_as_names
+      #
+      #   @return [Array<String>]
+      required :doing_business_as_names, ModernTreasury::ArrayOf[String]
+
+      # @!attribute email
+      #   The entity's primary email.
+      #
+      #   @return [String, nil]
+      required :email, String, nil?: true
+
+      # @!attribute first_name
+      #   An individual's first name.
+      #
+      #   @return [String, nil]
+      required :first_name, String, nil?: true
+
+      # @!attribute identifications
+      #   A list of identifications for the legal entity.
+      #
+      #   @return [Array<ModernTreasury::Models::LegalEntity::Identification>]
+      required :identifications,
+               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::Identification] }
+
+      # @!attribute last_name
+      #   An individual's last name.
+      #
+      #   @return [String, nil]
+      required :last_name, String, nil?: true
+
+      # @!attribute legal_entity_associations
+      #   The legal entity associations and its child legal entities.
+      #
+      #   @return [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
+      required :legal_entity_associations,
+               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociation] },
+               nil?: true
+
+      # @!attribute legal_entity_type
+      #   The type of legal entity.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType]
+      required :legal_entity_type, enum: -> { ModernTreasury::Models::LegalEntity::LegalEntityType }
+
+      # @!attribute legal_structure
+      #   The business's legal structure.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil]
+      required :legal_structure, enum: -> { ModernTreasury::Models::LegalEntity::LegalStructure }, nil?: true
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #     if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute middle_name
+      #   An individual's middle name.
+      #
+      #   @return [String, nil]
+      required :middle_name, String, nil?: true
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute phone_numbers
+      #
+      #   @return [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
+      required :phone_numbers, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::PhoneNumber] }
+
+      # @!attribute politically_exposed_person
+      #   Whether the individual is a politically exposed person.
+      #
+      #   @return [Boolean, nil]
+      required :politically_exposed_person, ModernTreasury::BooleanModel, nil?: true
+
+      # @!attribute preferred_name
+      #   An individual's preferred name.
+      #
+      #   @return [String, nil]
+      required :preferred_name, String, nil?: true
+
+      # @!attribute prefix
+      #   An individual's prefix.
+      #
+      #   @return [String, nil]
+      required :prefix, String, nil?: true
+
+      # @!attribute risk_rating
+      #   The risk rating of the legal entity. One of low, medium, high.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil]
+      required :risk_rating, enum: -> { ModernTreasury::Models::LegalEntity::RiskRating }, nil?: true
+
+      # @!attribute suffix
+      #   An individual's suffix.
+      #
+      #   @return [String, nil]
+      required :suffix, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute wealth_and_employment_details
+      #
+      #   @return [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
+      required :wealth_and_employment_details,
+               -> { ModernTreasury::Models::WealthAndEmploymentDetails },
+               nil?: true
+
+      # @!attribute website
+      #   The entity's primary website URL.
+      #
+      #   @return [String, nil]
+      required :website, String, nil?: true
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param addresses [Array<ModernTreasury::Models::LegalEntity::Address>]
+      #   # @param bank_settings [ModernTreasury::Models::BankSettings, nil]
+      #   # @param business_name [String, nil]
+      #   # @param citizenship_country [String, nil]
+      #   # @param created_at [Time]
+      #   # @param date_formed [Date, nil]
+      #   # @param date_of_birth [Date, nil]
+      #   # @param discarded_at [Time, nil]
+      #   # @param doing_business_as_names [Array<String>]
+      #   # @param email [String, nil]
+      #   # @param first_name [String, nil]
+      #   # @param identifications [Array<ModernTreasury::Models::LegalEntity::Identification>]
+      #   # @param last_name [String, nil]
+      #   # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
+      #   # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType]
+      #   # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param middle_name [String, nil]
+      #   # @param object [String]
+      #   # @param phone_numbers [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
+      #   # @param politically_exposed_person [Boolean, nil]
+      #   # @param preferred_name [String, nil]
+      #   # @param prefix [String, nil]
+      #   # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil]
+      #   # @param suffix [String, nil]
+      #   # @param updated_at [Time]
+      #   # @param wealth_and_employment_details [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
+      #   # @param website [String, nil]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     addresses:,
+      #     bank_settings:,
+      #     business_name:,
+      #     citizenship_country:,
+      #     created_at:,
+      #     date_formed:,
+      #     date_of_birth:,
+      #     discarded_at:,
+      #     doing_business_as_names:,
+      #     email:,
+      #     first_name:,
+      #     identifications:,
+      #     last_name:,
+      #     legal_entity_associations:,
+      #     legal_entity_type:,
+      #     legal_structure:,
+      #     live_mode:,
+      #     metadata:,
+      #     middle_name:,
+      #     object:,
+      #     phone_numbers:,
+      #     politically_exposed_person:,
+      #     preferred_name:,
+      #     prefix:,
+      #     risk_rating:,
+      #     suffix:,
+      #     updated_at:,
+      #     wealth_and_employment_details:,
+      #     website:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class Address < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute address_types
+        #   The types of this address.
+        #
+        #   @return [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
+        required :address_types,
+                 -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntity::Address::AddressType] }
+
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute discarded_at
+        #
+        #   @return [Time, nil]
+        required :discarded_at, Time, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute live_mode
+        #   This field will be true if this object exists in the live environment or false
+        #     if it exists in the test environment.
+        #
+        #   @return [Boolean]
+        required :live_mode, ModernTreasury::BooleanModel
+
+        # @!attribute locality
+        #   Locality or City.
+        #
+        #   @return [String, nil]
+        required :locality, String, nil?: true
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State.
+        #
+        #   @return [String, nil]
+        required :region, String, nil?: true
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
+        #   # @param country [String, nil]
+        #   # @param created_at [Time]
+        #   # @param discarded_at [Time, nil]
+        #   # @param line1 [String, nil]
+        #   # @param line2 [String, nil]
+        #   # @param live_mode [Boolean]
+        #   # @param locality [String, nil]
+        #   # @param object [String]
+        #   # @param postal_code [String, nil]
+        #   # @param region [String, nil]
+        #   # @param updated_at [Time]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     address_types:,
+        #     country:,
+        #     created_at:,
+        #     discarded_at:,
+        #     line1:,
+        #     line2:,
+        #     live_mode:,
+        #     locality:,
+        #     object:,
+        #     postal_code:,
+        #     region:,
+        #     updated_at:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        module AddressType
+          extend ModernTreasury::Enum
+
+          BUSINESS = :business
+          MAILING = :mailing
+          OTHER = :other
+          PO_BOX = :po_box
+          RESIDENTIAL = :residential
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+
+      class Identification < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute discarded_at
+        #
+        #   @return [Time, nil]
+        required :discarded_at, Time, nil?: true
+
+        # @!attribute id_type
+        #   The type of ID number.
+        #
+        #   @return [Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType]
+        required :id_type, enum: -> { ModernTreasury::Models::LegalEntity::Identification::IDType }
+
+        # @!attribute issuing_country
+        #   The ISO 3166-1 alpha-2 country code of the country that issued the
+        #     identification
+        #
+        #   @return [String, nil]
+        required :issuing_country, String, nil?: true
+
+        # @!attribute live_mode
+        #   This field will be true if this object exists in the live environment or false
+        #     if it exists in the test environment.
+        #
+        #   @return [Boolean]
+        required :live_mode, ModernTreasury::BooleanModel
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param created_at [Time]
+        #   # @param discarded_at [Time, nil]
+        #   # @param id_type [Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType]
+        #   # @param issuing_country [String, nil]
+        #   # @param live_mode [Boolean]
+        #   # @param object [String]
+        #   # @param updated_at [Time]
+        #   #
+        #   def initialize(id:, created_at:, discarded_at:, id_type:, issuing_country:, live_mode:, object:, updated_at:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        # The type of ID number.
+        module IDType
+          extend ModernTreasury::Enum
+
+          AR_CUIL = :ar_cuil
+          AR_CUIT = :ar_cuit
+          BR_CNPJ = :br_cnpj
+          BR_CPF = :br_cpf
+          CL_RUN = :cl_run
+          CL_RUT = :cl_rut
+          CO_CEDULAS = :co_cedulas
+          CO_NIT = :co_nit
+          HN_ID = :hn_id
+          HN_RTN = :hn_rtn
+          IN_LEI = :in_lei
+          KR_BRN = :kr_brn
+          KR_CRN = :kr_crn
+          KR_RRN = :kr_rrn
+          PASSPORT = :passport
+          SA_TIN = :sa_tin
+          SA_VAT = :sa_vat
+          US_EIN = :us_ein
+          US_ITIN = :us_itin
+          US_SSN = :us_ssn
+          VN_TIN = :vn_tin
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+
+      # The type of legal entity.
+      module LegalEntityType
+        extend ModernTreasury::Enum
+
+        BUSINESS = :business
+        INDIVIDUAL = :individual
+        JOINT = :joint
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The business's legal structure.
+      module LegalStructure
+        extend ModernTreasury::Enum
+
+        CORPORATION = :corporation
+        LLC = :llc
+        NON_PROFIT = :non_profit
+        PARTNERSHIP = :partnership
+        SOLE_PROPRIETORSHIP = :sole_proprietorship
+        TRUST = :trust
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class PhoneNumber < ModernTreasury::BaseModel
+        # @!attribute [r] phone_number
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :phone_number
+
+        # @!parse
+        #   # A list of phone numbers in E.164 format.
+        #   #
+        #   # @param phone_number [String]
+        #   #
+        #   def initialize(phone_number: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      # The risk rating of the legal entity. One of low, medium, high.
+      module RiskRating
+        extend ModernTreasury::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end