Module: ModernTreasury::Models::LegalEntity::Address::AddressType

Extended by:
Internal::Type::Enum
Defined in:
lib/modern_treasury/models/legal_entity.rb,
sig/modern_treasury/models/legal_entity.rbs

Constant Summary collapse

BUSINESS =

Returns:

  • (:business) 
:business
BUSINESS_PHYSICAL =

Returns:

  • (:business_physical) 
:business_physical
BUSINESS_REGISTERED =

Returns:

  • (:business_registered) 
:business_registered
MAILING =

Returns:

  • (:mailing) 
:mailing
OTHER =

Returns:

  • (:other) 
:other
PO_BOX =

Returns:

  • (:po_box) 
:po_box
RESIDENTIAL =

Returns:

  • (:residential) 
:residential

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(id:, address_types:, country:, created_at:, discarded_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, primary:, region:, updated_at:) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::LegalEntity::Address for more details.

Parameters:

  • id (String)
  • address_types (Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>) —

    The types of this address.

  • country (String, nil) —

    Country code conforms to [ISO 3166-1 alpha-2]

  • created_at (Time)
  • discarded_at (Time, nil)
  • line1 (String, nil)
  • line2 (String, nil)
  • live_mode (Boolean) —

    This field will be true if this object exists in the live environment or false i

  • locality (String, nil) —

    Locality or City. Use the full city name rather than an abbreviation (e.g. San F

  • object (String)
  • postal_code (String, nil) —

    The postal code of the address.

  • primary (Boolean, nil) —

    Whether this address is the primary address for the legal entity. Optional; when

  • region (String, nil) —

    Region or State. This field is free-form; for US states, we recommend a two-lett

  • updated_at (Time) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 528

module AddressType
  extend ModernTreasury::Internal::Type::Enum

  BUSINESS = :business
  BUSINESS_PHYSICAL = :business_physical
  BUSINESS_REGISTERED = :business_registered
  MAILING = :mailing
  OTHER = :other
  PO_BOX = :po_box
  RESIDENTIAL = :residential

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[ModernTreasury::Models::LegalEntity::Address::address_type]

Returns:

  • (::Array[ModernTreasury::Models::LegalEntity::Address::address_type]) 


360
 
# File 'sig/modern_treasury/models/legal_entity.rbs', line 360

def self?.values: -> ::Array[ModernTreasury::Models::LegalEntity::Address::address_type]