modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

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

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