Class: Increase::Models::Entity::Joint::Individual

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity.rb

Defined Under Namespace

Classes: Address, Identification

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(city: , line1: , line2: , state: , zip: ) ⇒ Object

Some parameter documentations has been truncated, see Address for more details.

The person’s address.

Parameters:

  • city (String) (defaults to: ) —

    The city of the address.

  • line1 (String) (defaults to: ) —

    The first line of the address.

  • line2 (String, nil) (defaults to: ) —

    The second line of the address.

  • state (String) (defaults to: ) —

    The two-letter United States Postal Service (USPS) abbreviation for the state of

  • zip (String) (defaults to: ) —

    The ZIP code of the address.



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/increase/models/entity.rb', line 649

class Individual < Increase::Internal::Type::BaseModel
  # @!attribute address
  #   The person's address.
  #
  #   @return [Increase::Models::Entity::Joint::Individual::Address]
  required :address, -> { Increase::Entity::Joint::Individual::Address }

  # @!attribute date_of_birth
  #   The person's date of birth in YYYY-MM-DD format.
  #
  #   @return [Date]
  required :date_of_birth, Date

  # @!attribute identification
  #   A means of verifying the person's identity.
  #
  #   @return [Increase::Models::Entity::Joint::Individual::Identification]
  required :identification, -> { Increase::Entity::Joint::Individual::Identification }

  # @!attribute name
  #   The person's legal name.
  #
  #   @return [String]
  required :name, String

  # @!method initialize(address:, date_of_birth:, identification:, name:)
  #   @param address [Increase::Models::Entity::Joint::Individual::Address] The person's address.
  #
  #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
  #
  #   @param identification [Increase::Models::Entity::Joint::Individual::Identification] A means of verifying the person's identity.
  #
  #   @param name [String] The person's legal name.

  # @see Increase::Models::Entity::Joint::Individual#address
  class Address < Increase::Internal::Type::BaseModel
    # @!attribute city
    #   The city of the address.
    #
    #   @return [String]
    required :city, String

    # @!attribute line1
    #   The first line of the address.
    #
    #   @return [String]
    required :line1, String

    # @!attribute line2
    #   The second line of the address.
    #
    #   @return [String, nil]
    required :line2, String, nil?: true

    # @!attribute state
    #   The two-letter United States Postal Service (USPS) abbreviation for the state of
    #   the address.
    #
    #   @return [String]
    required :state, String

    # @!attribute zip
    #   The ZIP code of the address.
    #
    #   @return [String]
    required :zip, String

    # @!method initialize(city:, line1:, line2:, state:, zip:)
    #   Some parameter documentations has been truncated, see
    #   {Increase::Models::Entity::Joint::Individual::Address} for more details.
    #
    #   The person's address.
    #
    #   @param city [String] The city of the address.
    #
    #   @param line1 [String] The first line of the address.
    #
    #   @param line2 [String, nil] The second line of the address.
    #
    #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
    #
    #   @param zip [String] The ZIP code of the address.
  end

  # @see Increase::Models::Entity::Joint::Individual#identification
  class Identification < Increase::Internal::Type::BaseModel
    # @!attribute method_
    #   A method that can be used to verify the individual's identity.
    #
    #   @return [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method]
    required :method_,
             enum: -> { Increase::Entity::Joint::Individual::Identification::Method },
             api_name: :method

    # @!attribute number_last4
    #   The last 4 digits of the identification number that can be used to verify the
    #   individual's identity.
    #
    #   @return [String]
    required :number_last4, String

    # @!method initialize(method_:, number_last4:)
    #   Some parameter documentations has been truncated, see
    #   {Increase::Models::Entity::Joint::Individual::Identification} for more details.
    #
    #   A means of verifying the person's identity.
    #
    #   @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity.
    #
    #   @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in

    # A method that can be used to verify the individual's identity.
    #
    # @see Increase::Models::Entity::Joint::Individual::Identification#method_
    module Method
      extend Increase::Internal::Type::Enum

      # A social security number.
      SOCIAL_SECURITY_NUMBER = :social_security_number

      # An individual taxpayer identification number (ITIN).
      INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number

      # A passport number.
      PASSPORT = :passport

      # A driver's license number.
      DRIVERS_LICENSE = :drivers_license

      # Another identifying document.
      OTHER = :other

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

Instance Attribute Details

#address ⇒ Increase::Models::Entity::Joint::Individual::Address

The person’s address.

Returns:



654
 
# File 'lib/increase/models/entity.rb', line 654

required :address, -> { Increase::Entity::Joint::Individual::Address }

#date_of_birth ⇒ Date

The person’s date of birth in YYYY-MM-DD format.

Returns:

  • (Date) 


660
 
# File 'lib/increase/models/entity.rb', line 660

required :date_of_birth, Date

#identification ⇒ Increase::Models::Entity::Joint::Individual::Identification

A means of verifying the person’s identity.

Returns:



666
 
# File 'lib/increase/models/entity.rb', line 666

required :identification, -> { Increase::Entity::Joint::Individual::Identification }

#name ⇒ String

The person’s legal name.

Returns:

  • (String) 


672
 
# File 'lib/increase/models/entity.rb', line 672

required :name, String