modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/rbi/lib/modern_treasury/models/legal_entity.rbi

@@ -0,0 +1,748 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LegalEntity < ModernTreasury::BaseModel
+      sig { returns(String) }
+      def id
+      end
+
+      sig { params(_: String).returns(String) }
+      def id=(_)
+      end
+
+      sig { returns(T::Array[ModernTreasury::Models::LegalEntity::Address]) }
+      def addresses
+      end
+
+      sig do
+        params(_: T::Array[ModernTreasury::Models::LegalEntity::Address])
+          .returns(T::Array[ModernTreasury::Models::LegalEntity::Address])
+      end
+      def addresses=(_)
+      end
+
+      sig { returns(T.nilable(ModernTreasury::Models::BankSettings)) }
+      def bank_settings
+      end
+
+      sig do
+        params(_: T.nilable(ModernTreasury::Models::BankSettings))
+          .returns(T.nilable(ModernTreasury::Models::BankSettings))
+      end
+      def bank_settings=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def business_name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def business_name=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def citizenship_country
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def citizenship_country=(_)
+      end
+
+      sig { returns(Time) }
+      def created_at
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def created_at=(_)
+      end
+
+      sig { returns(T.nilable(Date)) }
+      def date_formed
+      end
+
+      sig { params(_: T.nilable(Date)).returns(T.nilable(Date)) }
+      def date_formed=(_)
+      end
+
+      sig { returns(T.nilable(Date)) }
+      def date_of_birth
+      end
+
+      sig { params(_: T.nilable(Date)).returns(T.nilable(Date)) }
+      def date_of_birth=(_)
+      end
+
+      sig { returns(T.nilable(Time)) }
+      def discarded_at
+      end
+
+      sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
+      def discarded_at=(_)
+      end
+
+      sig { returns(T::Array[String]) }
+      def doing_business_as_names
+      end
+
+      sig { params(_: T::Array[String]).returns(T::Array[String]) }
+      def doing_business_as_names=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def email
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def email=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def first_name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def first_name=(_)
+      end
+
+      sig { returns(T::Array[ModernTreasury::Models::LegalEntity::Identification]) }
+      def identifications
+      end
+
+      sig do
+        params(_: T::Array[ModernTreasury::Models::LegalEntity::Identification])
+          .returns(T::Array[ModernTreasury::Models::LegalEntity::Identification])
+      end
+      def identifications=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def last_name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def last_name=(_)
+      end
+
+      sig { returns(T.nilable(T::Array[ModernTreasury::Models::LegalEntityAssociation])) }
+      def legal_entity_associations
+      end
+
+      sig do
+        params(_: T.nilable(T::Array[ModernTreasury::Models::LegalEntityAssociation]))
+          .returns(T.nilable(T::Array[ModernTreasury::Models::LegalEntityAssociation]))
+      end
+      def legal_entity_associations=(_)
+      end
+
+      sig { returns(Symbol) }
+      def legal_entity_type
+      end
+
+      sig { params(_: Symbol).returns(Symbol) }
+      def legal_entity_type=(_)
+      end
+
+      sig { returns(T.nilable(Symbol)) }
+      def legal_structure
+      end
+
+      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+      def legal_structure=(_)
+      end
+
+      sig { returns(T::Boolean) }
+      def live_mode
+      end
+
+      sig { params(_: T::Boolean).returns(T::Boolean) }
+      def live_mode=(_)
+      end
+
+      sig { returns(T::Hash[Symbol, String]) }
+      def metadata
+      end
+
+      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
+      def metadata=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def middle_name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def middle_name=(_)
+      end
+
+      sig { returns(String) }
+      def object
+      end
+
+      sig { params(_: String).returns(String) }
+      def object=(_)
+      end
+
+      sig { returns(T::Array[ModernTreasury::Models::LegalEntity::PhoneNumber]) }
+      def phone_numbers
+      end
+
+      sig do
+        params(_: T::Array[ModernTreasury::Models::LegalEntity::PhoneNumber])
+          .returns(T::Array[ModernTreasury::Models::LegalEntity::PhoneNumber])
+      end
+      def phone_numbers=(_)
+      end
+
+      sig { returns(T.nilable(T::Boolean)) }
+      def politically_exposed_person
+      end
+
+      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+      def politically_exposed_person=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def preferred_name
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def preferred_name=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def prefix
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def prefix=(_)
+      end
+
+      sig { returns(T.nilable(Symbol)) }
+      def risk_rating
+      end
+
+      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+      def risk_rating=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def suffix
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def suffix=(_)
+      end
+
+      sig { returns(Time) }
+      def updated_at
+      end
+
+      sig { params(_: Time).returns(Time) }
+      def updated_at=(_)
+      end
+
+      sig { returns(T.nilable(ModernTreasury::Models::WealthAndEmploymentDetails)) }
+      def wealth_and_employment_details
+      end
+
+      sig do
+        params(_: T.nilable(ModernTreasury::Models::WealthAndEmploymentDetails))
+          .returns(T.nilable(ModernTreasury::Models::WealthAndEmploymentDetails))
+      end
+      def wealth_and_employment_details=(_)
+      end
+
+      sig { returns(T.nilable(String)) }
+      def website
+      end
+
+      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+      def website=(_)
+      end
+
+      sig do
+        params(
+          id: String,
+          addresses: T::Array[ModernTreasury::Models::LegalEntity::Address],
+          bank_settings: T.nilable(ModernTreasury::Models::BankSettings),
+          business_name: T.nilable(String),
+          citizenship_country: T.nilable(String),
+          created_at: Time,
+          date_formed: T.nilable(Date),
+          date_of_birth: T.nilable(Date),
+          discarded_at: T.nilable(Time),
+          doing_business_as_names: T::Array[String],
+          email: T.nilable(String),
+          first_name: T.nilable(String),
+          identifications: T::Array[ModernTreasury::Models::LegalEntity::Identification],
+          last_name: T.nilable(String),
+          legal_entity_associations: T.nilable(T::Array[ModernTreasury::Models::LegalEntityAssociation]),
+          legal_entity_type: Symbol,
+          legal_structure: T.nilable(Symbol),
+          live_mode: T::Boolean,
+          metadata: T::Hash[Symbol, String],
+          middle_name: T.nilable(String),
+          object: String,
+          phone_numbers: T::Array[ModernTreasury::Models::LegalEntity::PhoneNumber],
+          politically_exposed_person: T.nilable(T::Boolean),
+          preferred_name: T.nilable(String),
+          prefix: T.nilable(String),
+          risk_rating: T.nilable(Symbol),
+          suffix: T.nilable(String),
+          updated_at: Time,
+          wealth_and_employment_details: T.nilable(ModernTreasury::Models::WealthAndEmploymentDetails),
+          website: T.nilable(String)
+        )
+          .void
+      end
+      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:
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              addresses: T::Array[ModernTreasury::Models::LegalEntity::Address],
+              bank_settings: T.nilable(ModernTreasury::Models::BankSettings),
+              business_name: T.nilable(String),
+              citizenship_country: T.nilable(String),
+              created_at: Time,
+              date_formed: T.nilable(Date),
+              date_of_birth: T.nilable(Date),
+              discarded_at: T.nilable(Time),
+              doing_business_as_names: T::Array[String],
+              email: T.nilable(String),
+              first_name: T.nilable(String),
+              identifications: T::Array[ModernTreasury::Models::LegalEntity::Identification],
+              last_name: T.nilable(String),
+              legal_entity_associations: T.nilable(T::Array[ModernTreasury::Models::LegalEntityAssociation]),
+              legal_entity_type: Symbol,
+              legal_structure: T.nilable(Symbol),
+              live_mode: T::Boolean,
+              metadata: T::Hash[Symbol, String],
+              middle_name: T.nilable(String),
+              object: String,
+              phone_numbers: T::Array[ModernTreasury::Models::LegalEntity::PhoneNumber],
+              politically_exposed_person: T.nilable(T::Boolean),
+              preferred_name: T.nilable(String),
+              prefix: T.nilable(String),
+              risk_rating: T.nilable(Symbol),
+              suffix: T.nilable(String),
+              updated_at: Time,
+              wealth_and_employment_details: T.nilable(ModernTreasury::Models::WealthAndEmploymentDetails),
+              website: T.nilable(String)
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class Address < ModernTreasury::BaseModel
+        sig { returns(String) }
+        def id
+        end
+
+        sig { params(_: String).returns(String) }
+        def id=(_)
+        end
+
+        sig { returns(T::Array[Symbol]) }
+        def address_types
+        end
+
+        sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) }
+        def address_types=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def country
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def country=(_)
+        end
+
+        sig { returns(Time) }
+        def created_at
+        end
+
+        sig { params(_: Time).returns(Time) }
+        def created_at=(_)
+        end
+
+        sig { returns(T.nilable(Time)) }
+        def discarded_at
+        end
+
+        sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
+        def discarded_at=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def line1
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def line1=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def line2
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def line2=(_)
+        end
+
+        sig { returns(T::Boolean) }
+        def live_mode
+        end
+
+        sig { params(_: T::Boolean).returns(T::Boolean) }
+        def live_mode=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def locality
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def locality=(_)
+        end
+
+        sig { returns(String) }
+        def object
+        end
+
+        sig { params(_: String).returns(String) }
+        def object=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def postal_code
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def postal_code=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def region
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def region=(_)
+        end
+
+        sig { returns(Time) }
+        def updated_at
+        end
+
+        sig { params(_: Time).returns(Time) }
+        def updated_at=(_)
+        end
+
+        sig do
+          params(
+            id: String,
+            address_types: T::Array[Symbol],
+            country: T.nilable(String),
+            created_at: Time,
+            discarded_at: T.nilable(Time),
+            line1: T.nilable(String),
+            line2: T.nilable(String),
+            live_mode: T::Boolean,
+            locality: T.nilable(String),
+            object: String,
+            postal_code: T.nilable(String),
+            region: T.nilable(String),
+            updated_at: Time
+          )
+            .void
+        end
+        def initialize(
+          id:,
+          address_types:,
+          country:,
+          created_at:,
+          discarded_at:,
+          line1:,
+          line2:,
+          live_mode:,
+          locality:,
+          object:,
+          postal_code:,
+          region:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                address_types: T::Array[Symbol],
+                country: T.nilable(String),
+                created_at: Time,
+                discarded_at: T.nilable(Time),
+                line1: T.nilable(String),
+                line2: T.nilable(String),
+                live_mode: T::Boolean,
+                locality: T.nilable(String),
+                object: String,
+                postal_code: T.nilable(String),
+                region: T.nilable(String),
+                updated_at: Time
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class AddressType < ModernTreasury::Enum
+          abstract!
+
+          BUSINESS = :business
+          MAILING = :mailing
+          OTHER = :other
+          PO_BOX = :po_box
+          RESIDENTIAL = :residential
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+      end
+
+      class Identification < ModernTreasury::BaseModel
+        sig { returns(String) }
+        def id
+        end
+
+        sig { params(_: String).returns(String) }
+        def id=(_)
+        end
+
+        sig { returns(Time) }
+        def created_at
+        end
+
+        sig { params(_: Time).returns(Time) }
+        def created_at=(_)
+        end
+
+        sig { returns(T.nilable(Time)) }
+        def discarded_at
+        end
+
+        sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
+        def discarded_at=(_)
+        end
+
+        sig { returns(Symbol) }
+        def id_type
+        end
+
+        sig { params(_: Symbol).returns(Symbol) }
+        def id_type=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def issuing_country
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def issuing_country=(_)
+        end
+
+        sig { returns(T::Boolean) }
+        def live_mode
+        end
+
+        sig { params(_: T::Boolean).returns(T::Boolean) }
+        def live_mode=(_)
+        end
+
+        sig { returns(String) }
+        def object
+        end
+
+        sig { params(_: String).returns(String) }
+        def object=(_)
+        end
+
+        sig { returns(Time) }
+        def updated_at
+        end
+
+        sig { params(_: Time).returns(Time) }
+        def updated_at=(_)
+        end
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            discarded_at: T.nilable(Time),
+            id_type: Symbol,
+            issuing_country: T.nilable(String),
+            live_mode: T::Boolean,
+            object: String,
+            updated_at: Time
+          )
+            .void
+        end
+        def initialize(
+          id:,
+          created_at:,
+          discarded_at:,
+          id_type:,
+          issuing_country:,
+          live_mode:,
+          object:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                created_at: Time,
+                discarded_at: T.nilable(Time),
+                id_type: Symbol,
+                issuing_country: T.nilable(String),
+                live_mode: T::Boolean,
+                object: String,
+                updated_at: Time
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class IDType < ModernTreasury::Enum
+          abstract!
+
+          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
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+      end
+
+      class LegalEntityType < ModernTreasury::Enum
+        abstract!
+
+        BUSINESS = :business
+        INDIVIDUAL = :individual
+        JOINT = :joint
+
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      class LegalStructure < ModernTreasury::Enum
+        abstract!
+
+        CORPORATION = T.let(:corporation, T.nilable(Symbol))
+        LLC = T.let(:llc, T.nilable(Symbol))
+        NON_PROFIT = T.let(:non_profit, T.nilable(Symbol))
+        PARTNERSHIP = T.let(:partnership, T.nilable(Symbol))
+        SOLE_PROPRIETORSHIP = T.let(:sole_proprietorship, T.nilable(Symbol))
+        TRUST = T.let(:trust, T.nilable(Symbol))
+
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      class PhoneNumber < ModernTreasury::BaseModel
+        sig { returns(T.nilable(String)) }
+        def phone_number
+        end
+
+        sig { params(_: String).returns(String) }
+        def phone_number=(_)
+        end
+
+        sig { params(phone_number: String).void }
+        def initialize(phone_number: nil)
+        end
+
+        sig { override.returns({phone_number: String}) }
+        def to_hash
+        end
+      end
+
+      class RiskRating < ModernTreasury::Enum
+        abstract!
+
+        LOW = T.let(:low, T.nilable(Symbol))
+        MEDIUM = T.let(:medium, T.nilable(Symbol))
+        HIGH = T.let(:high, T.nilable(Symbol))
+
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end