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) —

    The city of the address.

  • line1 (String) —

    The first line of the address.

  • line2 (String, nil) —

    The second line of the address.

  • state (String) —

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

  • zip (String) —

    The ZIP code of the address.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/increase/models/entity.rb', line 460

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:



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

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

#date_of_birth ⇒ Date

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

Returns:

  • (Date) 


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

required :date_of_birth, Date

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

A means of verifying the person’s identity.

Returns:



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

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

#name ⇒ String

The person’s legal name.

Returns:

  • (String) 


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

required :name, String