increase 1.349.0 → 1.350.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_number.rb +3 -3
  4. data/lib/increase/models/ach_transfer.rb +12 -12
  5. data/lib/increase/models/balance_lookup.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  7. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  8. data/lib/increase/models/card_dispute.rb +9 -1
  9. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  10. data/lib/increase/models/card_payment.rb +58 -58
  11. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  12. data/lib/increase/models/card_token_capabilities.rb +2 -2
  13. data/lib/increase/models/check_deposit.rb +9 -9
  14. data/lib/increase/models/check_transfer.rb +2 -2
  15. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  16. data/lib/increase/models/declined_transaction.rb +12 -9
  17. data/lib/increase/models/digital_wallet_token.rb +9 -1
  18. data/lib/increase/models/entity.rb +5 -5
  19. data/lib/increase/models/entity_create_params.rb +332 -29
  20. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  21. data/lib/increase/models/entity_update_params.rb +472 -15
  22. data/lib/increase/models/fednow_transfer.rb +115 -4
  23. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  24. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  25. data/lib/increase/models/inbound_check_deposit.rb +2 -2
  26. data/lib/increase/models/inbound_fednow_transfer.rb +3 -0
  27. data/lib/increase/models/inbound_mail_item.rb +14 -1
  28. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  29. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  30. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  31. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  32. data/lib/increase/models/pending_transaction.rb +13 -13
  33. data/lib/increase/models/pending_transaction_list_params.rb +4 -6
  34. data/lib/increase/models/physical_card.rb +9 -1
  35. data/lib/increase/models/real_time_decision.rb +18 -18
  36. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  37. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  39. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  40. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  41. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  42. data/lib/increase/models/transaction.rb +141 -17
  43. data/lib/increase/models/transaction_list_params.rb +3 -0
  44. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  45. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  46. data/lib/increase/resources/cards.rb +2 -2
  47. data/lib/increase/resources/check_transfers.rb +1 -1
  48. data/lib/increase/resources/entities.rb +10 -2
  49. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  50. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  51. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  52. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  53. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  54. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  55. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  56. data/lib/increase/resources/simulations/programs.rb +6 -2
  57. data/lib/increase/resources/wire_transfers.rb +1 -1
  58. data/lib/increase/version.rb +1 -1
  59. data/rbi/increase/models/account_number.rbi +3 -3
  60. data/rbi/increase/models/ach_transfer.rbi +12 -12
  61. data/rbi/increase/models/balance_lookup.rbi +1 -1
  62. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  63. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  64. data/rbi/increase/models/card_dispute.rbi +8 -0
  65. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  66. data/rbi/increase/models/card_payment.rbi +58 -58
  67. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  68. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  69. data/rbi/increase/models/check_deposit.rbi +9 -9
  70. data/rbi/increase/models/check_transfer.rbi +2 -2
  71. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  72. data/rbi/increase/models/declined_transaction.rbi +16 -9
  73. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  74. data/rbi/increase/models/entity.rbi +5 -5
  75. data/rbi/increase/models/entity_create_params.rbi +547 -28
  76. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  77. data/rbi/increase/models/entity_update_params.rbi +814 -14
  78. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  79. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  80. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  81. data/rbi/increase/models/inbound_check_deposit.rbi +2 -2
  82. data/rbi/increase/models/inbound_fednow_transfer.rbi +7 -0
  83. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  84. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  85. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  86. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  87. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  88. data/rbi/increase/models/pending_transaction.rbi +13 -13
  89. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -6
  90. data/rbi/increase/models/physical_card.rbi +8 -0
  91. data/rbi/increase/models/real_time_decision.rbi +18 -18
  92. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  93. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  94. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  95. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  96. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  97. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  98. data/rbi/increase/models/transaction.rbi +260 -16
  99. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  100. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  101. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  102. data/rbi/increase/resources/cards.rbi +2 -2
  103. data/rbi/increase/resources/check_transfers.rbi +1 -1
  104. data/rbi/increase/resources/entities.rbi +10 -0
  105. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  106. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  107. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  108. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  109. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  110. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  111. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  112. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  113. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  114. data/sig/increase/models/card_dispute.rbs +5 -0
  115. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  116. data/sig/increase/models/declined_transaction.rbs +4 -0
  117. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  118. data/sig/increase/models/entity.rbs +3 -3
  119. data/sig/increase/models/entity_create_params.rbs +232 -1
  120. data/sig/increase/models/entity_update_params.rbs +366 -0
  121. data/sig/increase/models/fednow_transfer.rbs +113 -4
  122. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  123. data/sig/increase/models/inbound_fednow_transfer.rbs +4 -0
  124. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  125. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  126. data/sig/increase/models/physical_card.rbs +5 -0
  127. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  128. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  129. data/sig/increase/models/transaction.rbs +113 -0
  130. data/sig/increase/models/transaction_list_params.rbs +4 -0
  131. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  132. data/sig/increase/resources/entities.rbs +2 -0
  133. data/sig/increase/resources/simulations/programs.rbs +1 -0
  134. metadata +2 -2
@@ -504,9 +504,9 @@ module Increase
504
504
  required :actioner, enum: -> { Increase::DeclinedTransaction::Source::CardDecline::Actioner }
505
505
 
506
506
  # @!attribute additional_amounts
507
- # Additional amounts associated with the card authorization, such as ATM
508
- # surcharges fees. These are usually a subset of the `amount` field and are used
509
- # to provide more detailed information about the transaction.
507
+ # Additional amounts associated with the card authorization, such as ATM surcharge
508
+ # fees. These are usually a subset of the `amount` field and are used to provide
509
+ # more detailed information about the transaction.
510
510
  #
511
511
  # @return [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts]
512
512
  required :additional_amounts, -> { Increase::DeclinedTransaction::Source::CardDecline::AdditionalAmounts }
@@ -705,9 +705,9 @@ module Increase
705
705
  # stand-in processing, or the user through a real-time decision.
706
706
  #
707
707
  # @param additional_amounts [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts]
708
- # Additional amounts associated with the card authorization, such as ATM
709
- # surcharges fees. These are usually a subset of the `amount` field and are used
710
- # to provide more detailed information about the transaction.
708
+ # Additional amounts associated with the card authorization, such as ATM surcharge
709
+ # fees. These are usually a subset of the `amount` field and are used to provide
710
+ # more detailed information about the transaction.
711
711
  #
712
712
  # @param amount [Integer]
713
713
  # The declined amount in the minor unit of the destination account currency. For
@@ -910,9 +910,9 @@ module Increase
910
910
  nil?: true
911
911
 
912
912
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
913
- # Additional amounts associated with the card authorization, such as ATM
914
- # surcharges fees. These are usually a subset of the `amount` field and are used
915
- # to provide more detailed information about the transaction.
913
+ # Additional amounts associated with the card authorization, such as ATM surcharge
914
+ # fees. These are usually a subset of the `amount` field and are used to provide
915
+ # more detailed information about the transaction.
916
916
  #
917
917
  # @param clinic [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Clinic, nil]
918
918
  # The part of this transaction amount that was for clinic-related services.
@@ -2445,6 +2445,9 @@ module Increase
2445
2445
  # Your account is not enabled to receive FedNow transfers.
2446
2446
  FEDNOW_NOT_ENABLED = :fednow_not_enabled
2447
2447
 
2448
+ # The transaction is not allowed per Increase's terms.
2449
+ TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
2450
+
2448
2451
  # @!method self.values
2449
2452
  # @return [Array<Symbol>]
2450
2453
  end
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The identifier for the Account this Digital Wallet Token belongs to.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
13
19
  # @!attribute card_id
14
20
  # The identifier for the Card this Digital Wallet Token belongs to.
15
21
  #
@@ -75,13 +81,15 @@ module Increase
75
81
  # @return [Array<Increase::Models::DigitalWalletToken::Update>]
76
82
  required :updates, -> { Increase::Internal::Type::ArrayOf[Increase::DigitalWalletToken::Update] }
77
83
 
78
- # @!method initialize(id:, card_id:, cardholder:, created_at:, decline:, device:, dynamic_primary_account_number:, status:, token_requestor:, type:, updates:)
84
+ # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, decline:, device:, dynamic_primary_account_number:, status:, token_requestor:, type:, updates:)
79
85
  # A Digital Wallet Token is created when a user adds a Card to their Apple Pay or
80
86
  # Google Pay app. The Digital Wallet Token can be used for purchases just like a
81
87
  # Card.
82
88
  #
83
89
  # @param id [String] The Digital Wallet Token identifier.
84
90
  #
91
+ # @param account_id [String] The identifier for the Account this Digital Wallet Token belongs to.
92
+ #
85
93
  # @param card_id [String] The identifier for the Card this Digital Wallet Token belongs to.
86
94
  #
87
95
  # @param cardholder [Increase::Models::DigitalWalletToken::Cardholder]
@@ -1498,7 +1498,7 @@ module Increase
1498
1498
  required :agreed_at, Time
1499
1499
 
1500
1500
  # @!attribute ip_address
1501
- # The IP address the Entity accessed reviewed the terms from.
1501
+ # The IP address the Entity reviewed the terms from.
1502
1502
  #
1503
1503
  # @return [String, nil]
1504
1504
  required :ip_address, String, nil?: true
@@ -1512,7 +1512,7 @@ module Increase
1512
1512
  # @!method initialize(agreed_at:, ip_address:, terms_url:)
1513
1513
  # @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
1514
1514
  #
1515
- # @param ip_address [String, nil] The IP address the Entity accessed reviewed the terms from.
1515
+ # @param ip_address [String, nil] The IP address the Entity reviewed the terms from.
1516
1516
  #
1517
1517
  # @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
1518
1518
  end
@@ -2215,13 +2215,13 @@ module Increase
2215
2215
  module Category
2216
2216
  extend Increase::Internal::Type::Enum
2217
2217
 
2218
- # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
2218
+ # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity).
2219
2219
  ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
2220
2220
 
2221
- # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
2221
+ # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity).
2222
2222
  ENTITY_ADDRESS = :entity_address
2223
2223
 
2224
- # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
2224
+ # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity).
2225
2225
  ENTITY_IDENTITY = :entity_identity
2226
2226
 
2227
2227
  # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
@@ -56,6 +56,13 @@ module Increase
56
56
  # @return [Increase::Models::EntityCreateParams::RiskRating, nil]
57
57
  optional :risk_rating, -> { Increase::EntityCreateParams::RiskRating }
58
58
 
59
+ # @!attribute sole_proprietorship
60
+ # Details of the sole proprietorship entity to create. Required if `structure` is
61
+ # equal to `sole_proprietorship`.
62
+ #
63
+ # @return [Increase::Models::EntityCreateParams::SoleProprietorship, nil]
64
+ optional :sole_proprietorship, -> { Increase::EntityCreateParams::SoleProprietorship }
65
+
59
66
  # @!attribute supplemental_documents
60
67
  # Additional documentation associated with the entity.
61
68
  #
@@ -86,7 +93,7 @@ module Increase
86
93
  # @return [Increase::Models::EntityCreateParams::Trust, nil]
87
94
  optional :trust, -> { Increase::EntityCreateParams::Trust }
88
95
 
89
- # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
96
+ # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
90
97
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
91
98
  #
92
99
  # @param corporation [Increase::Models::EntityCreateParams::Corporation]
@@ -113,6 +120,10 @@ module Increase
113
120
  # An assessment of the entity's potential risk of involvement in financial crimes,
114
121
  # such as money laundering.
115
122
  #
123
+ # @param sole_proprietorship [Increase::Models::EntityCreateParams::SoleProprietorship]
124
+ # Details of the sole proprietorship entity to create. Required if `structure` is
125
+ # equal to `sole_proprietorship`.
126
+ #
116
127
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
117
128
  # Additional documentation associated with the entity.
118
129
  #
@@ -150,6 +161,9 @@ module Increase
150
161
  # A government authority.
151
162
  GOVERNMENT_AUTHORITY = :government_authority
152
163
 
164
+ # A sole proprietorship.
165
+ SOLE_PROPRIETORSHIP = :sole_proprietorship
166
+
153
167
  # @!method self.values
154
168
  # @return [Array<Symbol>]
155
169
  end
@@ -507,8 +521,7 @@ module Increase
507
521
  # An identification number that can be used to verify the individual's identity,
508
522
  # such as a social security number. For Social Security Numbers and Individual
509
523
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
510
- # separators. When testing in sandbox, use one of our
511
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
524
+ # separators.
512
525
  #
513
526
  # @return [String]
514
527
  required :number, String
@@ -549,8 +562,7 @@ module Increase
549
562
  # An identification number that can be used to verify the individual's identity,
550
563
  # such as a social security number. For Social Security Numbers and Individual
551
564
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
552
- # separators. When testing in sandbox, use one of our
553
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
565
+ # separators.
554
566
  #
555
567
  # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense]
556
568
  # Information about the United States driver's license used for identification.
@@ -737,9 +749,7 @@ module Increase
737
749
  class LegalIdentifier < Increase::Internal::Type::BaseModel
738
750
  # @!attribute value
739
751
  # The legal identifier itself. For US Employer Identification Numbers, submit nine
740
- # digits with no dashes or other separators. When testing in sandbox, use one of
741
- # our
742
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
752
+ # digits with no dashes or other separators.
743
753
  #
744
754
  # @return [String]
745
755
  required :value, String
@@ -759,9 +769,7 @@ module Increase
759
769
  #
760
770
  # @param value [String]
761
771
  # The legal identifier itself. For US Employer Identification Numbers, submit nine
762
- # digits with no dashes or other separators. When testing in sandbox, use one of
763
- # our
764
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
772
+ # digits with no dashes or other separators.
765
773
  #
766
774
  # @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category]
767
775
  # The category of the legal identifier.
@@ -1108,8 +1116,7 @@ module Increase
1108
1116
  # An identification number that can be used to verify the individual's identity,
1109
1117
  # such as a social security number. For Social Security Numbers and Individual
1110
1118
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1111
- # separators. When testing in sandbox, use one of our
1112
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1119
+ # separators.
1113
1120
  #
1114
1121
  # @return [String]
1115
1122
  required :number, String
@@ -1148,8 +1155,7 @@ module Increase
1148
1155
  # An identification number that can be used to verify the individual's identity,
1149
1156
  # such as a social security number. For Social Security Numbers and Individual
1150
1157
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1151
- # separators. When testing in sandbox, use one of our
1152
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1158
+ # separators.
1153
1159
  #
1154
1160
  # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense]
1155
1161
  # Information about the United States driver's license used for identification.
@@ -1456,8 +1462,7 @@ module Increase
1456
1462
  # An identification number that can be used to verify the individual's identity,
1457
1463
  # such as a social security number. For Social Security Numbers and Individual
1458
1464
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1459
- # separators. When testing in sandbox, use one of our
1460
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1465
+ # separators.
1461
1466
  #
1462
1467
  # @return [String]
1463
1468
  required :number, String
@@ -1496,8 +1501,7 @@ module Increase
1496
1501
  # An identification number that can be used to verify the individual's identity,
1497
1502
  # such as a social security number. For Social Security Numbers and Individual
1498
1503
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1499
- # separators. When testing in sandbox, use one of our
1500
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1504
+ # separators.
1501
1505
  #
1502
1506
  # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense]
1503
1507
  # Information about the United States driver's license used for identification.
@@ -1711,6 +1715,309 @@ module Increase
1711
1715
  end
1712
1716
  end
1713
1717
 
1718
+ class SoleProprietorship < Increase::Internal::Type::BaseModel
1719
+ # @!attribute address
1720
+ # The sole proprietorship's business address. Mail receiving locations like PO
1721
+ # Boxes and PMB's are disallowed.
1722
+ #
1723
+ # @return [Increase::Models::EntityCreateParams::SoleProprietorship::Address]
1724
+ required :address, -> { Increase::EntityCreateParams::SoleProprietorship::Address }
1725
+
1726
+ # @!attribute sole_proprietor
1727
+ # The individual who operates the sole proprietorship.
1728
+ #
1729
+ # @return [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor]
1730
+ required :sole_proprietor, -> { Increase::EntityCreateParams::SoleProprietorship::SoleProprietor }
1731
+
1732
+ # @!attribute doing_business_as_name
1733
+ # The name under which the sole proprietorship does business, if it is different
1734
+ # from the name of the sole proprietor.
1735
+ #
1736
+ # @return [String, nil]
1737
+ optional :doing_business_as_name, String
1738
+
1739
+ # @!attribute email
1740
+ # An email address for the sole proprietorship. Not every program requires an
1741
+ # email for submitted Entities.
1742
+ #
1743
+ # @return [String, nil]
1744
+ optional :email, String
1745
+
1746
+ # @!attribute industry_code
1747
+ # The North American Industry Classification System (NAICS) code for the sole
1748
+ # proprietorship's primary line of business. This is a number, like `5132` for
1749
+ # `Software Publishers`. A full list of classification codes is available
1750
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1751
+ #
1752
+ # @return [String, nil]
1753
+ optional :industry_code, String
1754
+
1755
+ # @!attribute tax_identifier
1756
+ # The United States Employer Identification Number (EIN) for the sole
1757
+ # proprietorship, if the sole proprietor has one. Submit nine digits with no
1758
+ # dashes or other separators.
1759
+ #
1760
+ # @return [String, nil]
1761
+ optional :tax_identifier, String
1762
+
1763
+ # @!attribute website
1764
+ # A website for the sole proprietorship. Not every program requires a website for
1765
+ # submitted Entities.
1766
+ #
1767
+ # @return [String, nil]
1768
+ optional :website, String
1769
+
1770
+ # @!method initialize(address:, sole_proprietor:, doing_business_as_name: nil, email: nil, industry_code: nil, tax_identifier: nil, website: nil)
1771
+ # Details of the sole proprietorship entity to create. Required if `structure` is
1772
+ # equal to `sole_proprietorship`.
1773
+ #
1774
+ # @param address [Increase::Models::EntityCreateParams::SoleProprietorship::Address]
1775
+ # The sole proprietorship's business address. Mail receiving locations like PO
1776
+ # Boxes and PMB's are disallowed.
1777
+ #
1778
+ # @param sole_proprietor [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor]
1779
+ # The individual who operates the sole proprietorship.
1780
+ #
1781
+ # @param doing_business_as_name [String]
1782
+ # The name under which the sole proprietorship does business, if it is different
1783
+ # from the name of the sole proprietor.
1784
+ #
1785
+ # @param email [String]
1786
+ # An email address for the sole proprietorship. Not every program requires an
1787
+ # email for submitted Entities.
1788
+ #
1789
+ # @param industry_code [String]
1790
+ # The North American Industry Classification System (NAICS) code for the sole
1791
+ # proprietorship's primary line of business. This is a number, like `5132` for
1792
+ # `Software Publishers`. A full list of classification codes is available
1793
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1794
+ #
1795
+ # @param tax_identifier [String]
1796
+ # The United States Employer Identification Number (EIN) for the sole
1797
+ # proprietorship, if the sole proprietor has one. Submit nine digits with no
1798
+ # dashes or other separators.
1799
+ #
1800
+ # @param website [String]
1801
+ # A website for the sole proprietorship. Not every program requires a website for
1802
+ # submitted Entities.
1803
+
1804
+ # @see Increase::Models::EntityCreateParams::SoleProprietorship#address
1805
+ class Address < Increase::Internal::Type::BaseModel
1806
+ # @!attribute city
1807
+ # The city of the address.
1808
+ #
1809
+ # @return [String]
1810
+ required :city, String
1811
+
1812
+ # @!attribute line1
1813
+ # The first line of the address. This is usually the street number and street.
1814
+ #
1815
+ # @return [String]
1816
+ required :line1, String
1817
+
1818
+ # @!attribute state
1819
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1820
+ # the address.
1821
+ #
1822
+ # @return [String]
1823
+ required :state, String
1824
+
1825
+ # @!attribute zip
1826
+ # The ZIP code of the address.
1827
+ #
1828
+ # @return [String]
1829
+ required :zip, String
1830
+
1831
+ # @!attribute line2
1832
+ # The second line of the address. This might be the floor or room number.
1833
+ #
1834
+ # @return [String, nil]
1835
+ optional :line2, String
1836
+
1837
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
1838
+ # The sole proprietorship's business address. Mail receiving locations like PO
1839
+ # Boxes and PMB's are disallowed.
1840
+ #
1841
+ # @param city [String] The city of the address.
1842
+ #
1843
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1844
+ #
1845
+ # @param state [String]
1846
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1847
+ # the address.
1848
+ #
1849
+ # @param zip [String] The ZIP code of the address.
1850
+ #
1851
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1852
+ end
1853
+
1854
+ # @see Increase::Models::EntityCreateParams::SoleProprietorship#sole_proprietor
1855
+ class SoleProprietor < Increase::Internal::Type::BaseModel
1856
+ # @!attribute address
1857
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1858
+ # PMB's are disallowed.
1859
+ #
1860
+ # @return [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Address]
1861
+ required :address, -> { Increase::EntityCreateParams::SoleProprietorship::SoleProprietor::Address }
1862
+
1863
+ # @!attribute date_of_birth
1864
+ # The person's date of birth in YYYY-MM-DD format.
1865
+ #
1866
+ # @return [Date]
1867
+ required :date_of_birth, Date
1868
+
1869
+ # @!attribute identification
1870
+ # A means of verifying the person's identity. Sole proprietors must be identified
1871
+ # with a `social_security_number` or an
1872
+ # `individual_taxpayer_identification_number`.
1873
+ #
1874
+ # @return [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification]
1875
+ required :identification,
1876
+ -> { Increase::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification }
1877
+
1878
+ # @!attribute name
1879
+ # The person's legal name.
1880
+ #
1881
+ # @return [String]
1882
+ required :name, String
1883
+
1884
+ # @!method initialize(address:, date_of_birth:, identification:, name:)
1885
+ # The individual who operates the sole proprietorship.
1886
+ #
1887
+ # @param address [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Address]
1888
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1889
+ # PMB's are disallowed.
1890
+ #
1891
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1892
+ #
1893
+ # @param identification [Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification]
1894
+ # A means of verifying the person's identity. Sole proprietors must be identified
1895
+ # with a `social_security_number` or an
1896
+ # `individual_taxpayer_identification_number`.
1897
+ #
1898
+ # @param name [String] The person's legal name.
1899
+
1900
+ # @see Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor#address
1901
+ class Address < Increase::Internal::Type::BaseModel
1902
+ # @!attribute city
1903
+ # The city, district, town, or village of the address.
1904
+ #
1905
+ # @return [String]
1906
+ required :city, String
1907
+
1908
+ # @!attribute country
1909
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1910
+ #
1911
+ # Defaults to `US`.
1912
+ #
1913
+ # @return [String]
1914
+ required :country, String
1915
+
1916
+ # @!attribute line1
1917
+ # The first line of the address. This is usually the street number and street.
1918
+ #
1919
+ # @return [String]
1920
+ required :line1, String
1921
+
1922
+ # @!attribute line2
1923
+ # The second line of the address. This might be the floor or room number.
1924
+ #
1925
+ # @return [String, nil]
1926
+ optional :line2, String
1927
+
1928
+ # @!attribute state
1929
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1930
+ # state, province, or region of the address. Required in certain countries.
1931
+ #
1932
+ # @return [String, nil]
1933
+ optional :state, String
1934
+
1935
+ # @!attribute zip
1936
+ # The ZIP or postal code of the address. Required in certain countries.
1937
+ #
1938
+ # @return [String, nil]
1939
+ optional :zip, String
1940
+
1941
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1942
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1943
+ # PMB's are disallowed.
1944
+ #
1945
+ # @param city [String] The city, district, town, or village of the address.
1946
+ #
1947
+ # @param country [String]
1948
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1949
+ #
1950
+ # Defaults to `US`.
1951
+ #
1952
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1953
+ #
1954
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1955
+ #
1956
+ # @param state [String]
1957
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1958
+ # state, province, or region of the address. Required in certain countries.
1959
+ #
1960
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
1961
+ end
1962
+
1963
+ # @see Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor#identification
1964
+ class Identification < Increase::Internal::Type::BaseModel
1965
+ # @!attribute method_
1966
+ # A method that can be used to verify the individual's identity.
1967
+ #
1968
+ # Defaults to `social_security_number`.
1969
+ #
1970
+ # @return [Symbol, Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification::Method]
1971
+ required :method_,
1972
+ enum: -> {
1973
+ Increase::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification::Method
1974
+ },
1975
+ api_name: :method
1976
+
1977
+ # @!attribute number
1978
+ # An identification number that can be used to verify the individual's identity,
1979
+ # such as a social security number. Submit nine digits with no dashes or other
1980
+ # separators.
1981
+ #
1982
+ # @return [String]
1983
+ required :number, String
1984
+
1985
+ # @!method initialize(method_:, number:)
1986
+ # A means of verifying the person's identity. Sole proprietors must be identified
1987
+ # with a `social_security_number` or an
1988
+ # `individual_taxpayer_identification_number`.
1989
+ #
1990
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification::Method]
1991
+ # A method that can be used to verify the individual's identity.
1992
+ #
1993
+ # Defaults to `social_security_number`.
1994
+ #
1995
+ # @param number [String]
1996
+ # An identification number that can be used to verify the individual's identity,
1997
+ # such as a social security number. Submit nine digits with no dashes or other
1998
+ # separators.
1999
+
2000
+ # A method that can be used to verify the individual's identity.
2001
+ #
2002
+ # Defaults to `social_security_number`.
2003
+ #
2004
+ # @see Increase::Models::EntityCreateParams::SoleProprietorship::SoleProprietor::Identification#method_
2005
+ module Method
2006
+ extend Increase::Internal::Type::Enum
2007
+
2008
+ # A social security number.
2009
+ SOCIAL_SECURITY_NUMBER = :social_security_number
2010
+
2011
+ # An individual taxpayer identification number (ITIN).
2012
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
2013
+
2014
+ # @!method self.values
2015
+ # @return [Array<Symbol>]
2016
+ end
2017
+ end
2018
+ end
2019
+ end
2020
+
1714
2021
  class SupplementalDocument < Increase::Internal::Type::BaseModel
1715
2022
  # @!attribute file_id
1716
2023
  # The identifier of the File containing the document.
@@ -1730,7 +2037,7 @@ module Increase
1730
2037
  required :agreed_at, Time
1731
2038
 
1732
2039
  # @!attribute ip_address
1733
- # The IP address the Entity accessed reviewed the terms from.
2040
+ # The IP address the Entity reviewed the terms from.
1734
2041
  #
1735
2042
  # @return [String]
1736
2043
  required :ip_address, String
@@ -1744,7 +2051,7 @@ module Increase
1744
2051
  # @!method initialize(agreed_at:, ip_address:, terms_url:)
1745
2052
  # @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
1746
2053
  #
1747
- # @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
2054
+ # @param ip_address [String] The IP address the Entity reviewed the terms from.
1748
2055
  #
1749
2056
  # @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
1750
2057
  end
@@ -2124,8 +2431,7 @@ module Increase
2124
2431
  # An identification number that can be used to verify the individual's identity,
2125
2432
  # such as a social security number. For Social Security Numbers and Individual
2126
2433
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2127
- # separators. When testing in sandbox, use one of our
2128
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2434
+ # separators.
2129
2435
  #
2130
2436
  # @return [String]
2131
2437
  required :number, String
@@ -2165,8 +2471,7 @@ module Increase
2165
2471
  # An identification number that can be used to verify the individual's identity,
2166
2472
  # such as a social security number. For Social Security Numbers and Individual
2167
2473
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2168
- # separators. When testing in sandbox, use one of our
2169
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2474
+ # separators.
2170
2475
  #
2171
2476
  # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense]
2172
2477
  # Information about the United States driver's license used for identification.
@@ -2471,8 +2776,7 @@ module Increase
2471
2776
  # An identification number that can be used to verify the individual's identity,
2472
2777
  # such as a social security number. For Social Security Numbers and Individual
2473
2778
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2474
- # separators. When testing in sandbox, use one of our
2475
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2779
+ # separators.
2476
2780
  #
2477
2781
  # @return [String]
2478
2782
  required :number, String
@@ -2511,8 +2815,7 @@ module Increase
2511
2815
  # An identification number that can be used to verify the individual's identity,
2512
2816
  # such as a social security number. For Social Security Numbers and Individual
2513
2817
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2514
- # separators. When testing in sandbox, use one of our
2515
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2818
+ # separators.
2516
2819
  #
2517
2820
  # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense]
2518
2821
  # Information about the United States driver's license used for identification.
@@ -57,7 +57,7 @@ module Increase
57
57
 
58
58
  class Status < Increase::Internal::Type::BaseModel
59
59
  # @!attribute in_
60
- # Filter Entity Onboarding Session for those with the specified status or
60
+ # Filter Entity Onboarding Sessions for those with the specified status or
61
61
  # statuses. For GET requests, this should be encoded as a comma-delimited string,
62
62
  # such as `?in=one,two,three`.
63
63
  #
@@ -70,7 +70,7 @@ module Increase
70
70
 
71
71
  # @!method initialize(in_: nil)
72
72
  # @param in_ [Array<Symbol, Increase::Models::EntityOnboardingSessionListParams::Status::In>]
73
- # Filter Entity Onboarding Session for those with the specified status or
73
+ # Filter Entity Onboarding Sessions for those with the specified status or
74
74
  # statuses. For GET requests, this should be encoded as a comma-delimited string,
75
75
  # such as `?in=one,two,three`.
76
76