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
@@ -75,6 +75,21 @@ module Increase
75
75
  end
76
76
  attr_writer :risk_rating
77
77
 
78
+ # Details of the sole proprietorship entity to update. If you specify this
79
+ # parameter and the entity is not a sole proprietorship, the request will fail.
80
+ sig do
81
+ returns(T.nilable(Increase::EntityUpdateParams::SoleProprietorship))
82
+ end
83
+ attr_reader :sole_proprietorship
84
+
85
+ sig do
86
+ params(
87
+ sole_proprietorship:
88
+ Increase::EntityUpdateParams::SoleProprietorship::OrHash
89
+ ).void
90
+ end
91
+ attr_writer :sole_proprietorship
92
+
78
93
  # New terms that the Entity agreed to. Not all programs are required to submit
79
94
  # this data. This will not archive previously submitted terms.
80
95
  sig do
@@ -125,6 +140,8 @@ module Increase
125
140
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
126
141
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
127
142
  risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
143
+ sole_proprietorship:
144
+ Increase::EntityUpdateParams::SoleProprietorship::OrHash,
128
145
  terms_agreements:
129
146
  T::Array[Increase::EntityUpdateParams::TermsAgreement::OrHash],
130
147
  third_party_verification:
@@ -152,6 +169,9 @@ module Increase
152
169
  # An assessment of the entity’s potential risk of involvement in financial crimes,
153
170
  # such as money laundering.
154
171
  risk_rating: nil,
172
+ # Details of the sole proprietorship entity to update. If you specify this
173
+ # parameter and the entity is not a sole proprietorship, the request will fail.
174
+ sole_proprietorship: nil,
155
175
  # New terms that the Entity agreed to. Not all programs are required to submit
156
176
  # this data. This will not archive previously submitted terms.
157
177
  terms_agreements: nil,
@@ -176,6 +196,8 @@ module Increase
176
196
  Increase::EntityUpdateParams::GovernmentAuthority,
177
197
  natural_person: Increase::EntityUpdateParams::NaturalPerson,
178
198
  risk_rating: Increase::EntityUpdateParams::RiskRating,
199
+ sole_proprietorship:
200
+ Increase::EntityUpdateParams::SoleProprietorship,
179
201
  terms_agreements:
180
202
  T::Array[Increase::EntityUpdateParams::TermsAgreement],
181
203
  third_party_verification:
@@ -885,8 +907,7 @@ module Increase
885
907
  # An identification number that can be used to verify the individual's identity,
886
908
  # such as a social security number. For Social Security Numbers and Individual
887
909
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
888
- # separators. When testing in sandbox, use one of our
889
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
910
+ # separators.
890
911
  sig { returns(String) }
891
912
  attr_accessor :number
892
913
 
@@ -969,8 +990,7 @@ module Increase
969
990
  # An identification number that can be used to verify the individual's identity,
970
991
  # such as a social security number. For Social Security Numbers and Individual
971
992
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
972
- # separators. When testing in sandbox, use one of our
973
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
993
+ # separators.
974
994
  number:,
975
995
  # Information about the United States driver's license used for identification.
976
996
  # Required if `method` is equal to `drivers_license`.
@@ -1350,6 +1370,790 @@ module Increase
1350
1370
  end
1351
1371
  end
1352
1372
 
1373
+ class SoleProprietorship < Increase::Internal::Type::BaseModel
1374
+ OrHash =
1375
+ T.type_alias do
1376
+ T.any(
1377
+ Increase::EntityUpdateParams::SoleProprietorship,
1378
+ Increase::Internal::AnyHash
1379
+ )
1380
+ end
1381
+
1382
+ # The sole proprietorship's business address. Mail receiving locations like PO
1383
+ # Boxes and PMB's are disallowed.
1384
+ sig do
1385
+ returns(
1386
+ T.nilable(Increase::EntityUpdateParams::SoleProprietorship::Address)
1387
+ )
1388
+ end
1389
+ attr_reader :address
1390
+
1391
+ sig do
1392
+ params(
1393
+ address:
1394
+ Increase::EntityUpdateParams::SoleProprietorship::Address::OrHash
1395
+ ).void
1396
+ end
1397
+ attr_writer :address
1398
+
1399
+ # An email address for the sole proprietorship. Not every program requires an
1400
+ # email for submitted Entities.
1401
+ sig { returns(T.nilable(String)) }
1402
+ attr_reader :email
1403
+
1404
+ sig { params(email: String).void }
1405
+ attr_writer :email
1406
+
1407
+ # The North American Industry Classification System (NAICS) code for the sole
1408
+ # proprietorship's primary line of business. This is a number, like `5132` for
1409
+ # `Software Publishers`. A full list of classification codes is available
1410
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1411
+ sig { returns(T.nilable(String)) }
1412
+ attr_reader :industry_code
1413
+
1414
+ sig { params(industry_code: String).void }
1415
+ attr_writer :industry_code
1416
+
1417
+ # Details of the individual who operates the sole proprietorship.
1418
+ sig do
1419
+ returns(
1420
+ T.nilable(
1421
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor
1422
+ )
1423
+ )
1424
+ end
1425
+ attr_reader :sole_proprietor
1426
+
1427
+ sig do
1428
+ params(
1429
+ sole_proprietor:
1430
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::OrHash
1431
+ ).void
1432
+ end
1433
+ attr_writer :sole_proprietor
1434
+
1435
+ # The United States Employer Identification Number (EIN) for the sole
1436
+ # proprietorship. Submit nine digits with no dashes or other separators.
1437
+ sig { returns(T.nilable(String)) }
1438
+ attr_reader :tax_identifier
1439
+
1440
+ sig { params(tax_identifier: String).void }
1441
+ attr_writer :tax_identifier
1442
+
1443
+ # A website for the sole proprietorship. Not every program requires a website for
1444
+ # submitted Entities.
1445
+ sig { returns(T.nilable(String)) }
1446
+ attr_reader :website
1447
+
1448
+ sig { params(website: String).void }
1449
+ attr_writer :website
1450
+
1451
+ # Details of the sole proprietorship entity to update. If you specify this
1452
+ # parameter and the entity is not a sole proprietorship, the request will fail.
1453
+ sig do
1454
+ params(
1455
+ address:
1456
+ Increase::EntityUpdateParams::SoleProprietorship::Address::OrHash,
1457
+ email: String,
1458
+ industry_code: String,
1459
+ sole_proprietor:
1460
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::OrHash,
1461
+ tax_identifier: String,
1462
+ website: String
1463
+ ).returns(T.attached_class)
1464
+ end
1465
+ def self.new(
1466
+ # The sole proprietorship's business address. Mail receiving locations like PO
1467
+ # Boxes and PMB's are disallowed.
1468
+ address: nil,
1469
+ # An email address for the sole proprietorship. Not every program requires an
1470
+ # email for submitted Entities.
1471
+ email: nil,
1472
+ # The North American Industry Classification System (NAICS) code for the sole
1473
+ # proprietorship's primary line of business. This is a number, like `5132` for
1474
+ # `Software Publishers`. A full list of classification codes is available
1475
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1476
+ industry_code: nil,
1477
+ # Details of the individual who operates the sole proprietorship.
1478
+ sole_proprietor: nil,
1479
+ # The United States Employer Identification Number (EIN) for the sole
1480
+ # proprietorship. Submit nine digits with no dashes or other separators.
1481
+ tax_identifier: nil,
1482
+ # A website for the sole proprietorship. Not every program requires a website for
1483
+ # submitted Entities.
1484
+ website: nil
1485
+ )
1486
+ end
1487
+
1488
+ sig do
1489
+ override.returns(
1490
+ {
1491
+ address:
1492
+ Increase::EntityUpdateParams::SoleProprietorship::Address,
1493
+ email: String,
1494
+ industry_code: String,
1495
+ sole_proprietor:
1496
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor,
1497
+ tax_identifier: String,
1498
+ website: String
1499
+ }
1500
+ )
1501
+ end
1502
+ def to_hash
1503
+ end
1504
+
1505
+ class Address < Increase::Internal::Type::BaseModel
1506
+ OrHash =
1507
+ T.type_alias do
1508
+ T.any(
1509
+ Increase::EntityUpdateParams::SoleProprietorship::Address,
1510
+ Increase::Internal::AnyHash
1511
+ )
1512
+ end
1513
+
1514
+ # The city of the address.
1515
+ sig { returns(String) }
1516
+ attr_accessor :city
1517
+
1518
+ # The first line of the address. This is usually the street number and street.
1519
+ sig { returns(String) }
1520
+ attr_accessor :line1
1521
+
1522
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1523
+ # the address.
1524
+ sig { returns(String) }
1525
+ attr_accessor :state
1526
+
1527
+ # The ZIP code of the address.
1528
+ sig { returns(String) }
1529
+ attr_accessor :zip
1530
+
1531
+ # The second line of the address. This might be the floor or room number.
1532
+ sig { returns(T.nilable(String)) }
1533
+ attr_reader :line2
1534
+
1535
+ sig { params(line2: String).void }
1536
+ attr_writer :line2
1537
+
1538
+ # The sole proprietorship's business address. Mail receiving locations like PO
1539
+ # Boxes and PMB's are disallowed.
1540
+ sig do
1541
+ params(
1542
+ city: String,
1543
+ line1: String,
1544
+ state: String,
1545
+ zip: String,
1546
+ line2: String
1547
+ ).returns(T.attached_class)
1548
+ end
1549
+ def self.new(
1550
+ # The city of the address.
1551
+ city:,
1552
+ # The first line of the address. This is usually the street number and street.
1553
+ line1:,
1554
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1555
+ # the address.
1556
+ state:,
1557
+ # The ZIP code of the address.
1558
+ zip:,
1559
+ # The second line of the address. This might be the floor or room number.
1560
+ line2: nil
1561
+ )
1562
+ end
1563
+
1564
+ sig do
1565
+ override.returns(
1566
+ {
1567
+ city: String,
1568
+ line1: String,
1569
+ state: String,
1570
+ zip: String,
1571
+ line2: String
1572
+ }
1573
+ )
1574
+ end
1575
+ def to_hash
1576
+ end
1577
+ end
1578
+
1579
+ class SoleProprietor < Increase::Internal::Type::BaseModel
1580
+ OrHash =
1581
+ T.type_alias do
1582
+ T.any(
1583
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor,
1584
+ Increase::Internal::AnyHash
1585
+ )
1586
+ end
1587
+
1588
+ # The sole proprietor's physical address. Mail receiving locations like PO Boxes
1589
+ # and PMB's are disallowed.
1590
+ sig do
1591
+ returns(
1592
+ T.nilable(
1593
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Address
1594
+ )
1595
+ )
1596
+ end
1597
+ attr_reader :address
1598
+
1599
+ sig do
1600
+ params(
1601
+ address:
1602
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Address::OrHash
1603
+ ).void
1604
+ end
1605
+ attr_writer :address
1606
+
1607
+ # A means of verifying the sole proprietor's identity. Unlike at creation, an
1608
+ # identity document is accepted here.
1609
+ sig do
1610
+ returns(
1611
+ T.nilable(
1612
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification
1613
+ )
1614
+ )
1615
+ end
1616
+ attr_reader :identification
1617
+
1618
+ sig do
1619
+ params(
1620
+ identification:
1621
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::OrHash
1622
+ ).void
1623
+ end
1624
+ attr_writer :identification
1625
+
1626
+ # The sole proprietor's legal name.
1627
+ sig { returns(T.nilable(String)) }
1628
+ attr_reader :name
1629
+
1630
+ sig { params(name: String).void }
1631
+ attr_writer :name
1632
+
1633
+ # Details of the individual who operates the sole proprietorship.
1634
+ sig do
1635
+ params(
1636
+ address:
1637
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Address::OrHash,
1638
+ identification:
1639
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::OrHash,
1640
+ name: String
1641
+ ).returns(T.attached_class)
1642
+ end
1643
+ def self.new(
1644
+ # The sole proprietor's physical address. Mail receiving locations like PO Boxes
1645
+ # and PMB's are disallowed.
1646
+ address: nil,
1647
+ # A means of verifying the sole proprietor's identity. Unlike at creation, an
1648
+ # identity document is accepted here.
1649
+ identification: nil,
1650
+ # The sole proprietor's legal name.
1651
+ name: nil
1652
+ )
1653
+ end
1654
+
1655
+ sig do
1656
+ override.returns(
1657
+ {
1658
+ address:
1659
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Address,
1660
+ identification:
1661
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification,
1662
+ name: String
1663
+ }
1664
+ )
1665
+ end
1666
+ def to_hash
1667
+ end
1668
+
1669
+ class Address < Increase::Internal::Type::BaseModel
1670
+ OrHash =
1671
+ T.type_alias do
1672
+ T.any(
1673
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Address,
1674
+ Increase::Internal::AnyHash
1675
+ )
1676
+ end
1677
+
1678
+ # The city, district, town, or village of the address.
1679
+ sig { returns(String) }
1680
+ attr_accessor :city
1681
+
1682
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1683
+ #
1684
+ # Defaults to `US`.
1685
+ sig { returns(String) }
1686
+ attr_accessor :country
1687
+
1688
+ # The first line of the address. This is usually the street number and street.
1689
+ sig { returns(String) }
1690
+ attr_accessor :line1
1691
+
1692
+ # The second line of the address. This might be the floor or room number.
1693
+ sig { returns(T.nilable(String)) }
1694
+ attr_reader :line2
1695
+
1696
+ sig { params(line2: String).void }
1697
+ attr_writer :line2
1698
+
1699
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1700
+ # state, province, or region of the address. Required in certain countries.
1701
+ sig { returns(T.nilable(String)) }
1702
+ attr_reader :state
1703
+
1704
+ sig { params(state: String).void }
1705
+ attr_writer :state
1706
+
1707
+ # The ZIP or postal code of the address. Required in certain countries.
1708
+ sig { returns(T.nilable(String)) }
1709
+ attr_reader :zip
1710
+
1711
+ sig { params(zip: String).void }
1712
+ attr_writer :zip
1713
+
1714
+ # The sole proprietor's physical address. Mail receiving locations like PO Boxes
1715
+ # and PMB's are disallowed.
1716
+ sig do
1717
+ params(
1718
+ city: String,
1719
+ country: String,
1720
+ line1: String,
1721
+ line2: String,
1722
+ state: String,
1723
+ zip: String
1724
+ ).returns(T.attached_class)
1725
+ end
1726
+ def self.new(
1727
+ # The city, district, town, or village of the address.
1728
+ city:,
1729
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1730
+ #
1731
+ # Defaults to `US`.
1732
+ country:,
1733
+ # The first line of the address. This is usually the street number and street.
1734
+ line1:,
1735
+ # The second line of the address. This might be the floor or room number.
1736
+ line2: nil,
1737
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1738
+ # state, province, or region of the address. Required in certain countries.
1739
+ state: nil,
1740
+ # The ZIP or postal code of the address. Required in certain countries.
1741
+ zip: nil
1742
+ )
1743
+ end
1744
+
1745
+ sig do
1746
+ override.returns(
1747
+ {
1748
+ city: String,
1749
+ country: String,
1750
+ line1: String,
1751
+ line2: String,
1752
+ state: String,
1753
+ zip: String
1754
+ }
1755
+ )
1756
+ end
1757
+ def to_hash
1758
+ end
1759
+ end
1760
+
1761
+ class Identification < Increase::Internal::Type::BaseModel
1762
+ OrHash =
1763
+ T.type_alias do
1764
+ T.any(
1765
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification,
1766
+ Increase::Internal::AnyHash
1767
+ )
1768
+ end
1769
+
1770
+ # A method that can be used to verify the individual's identity.
1771
+ #
1772
+ # Defaults to `social_security_number`.
1773
+ sig do
1774
+ returns(
1775
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::OrSymbol
1776
+ )
1777
+ end
1778
+ attr_accessor :method_
1779
+
1780
+ # An identification number that can be used to verify the individual's identity,
1781
+ # such as a social security number. For Social Security Numbers and Individual
1782
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1783
+ # separators.
1784
+ sig { returns(String) }
1785
+ attr_accessor :number
1786
+
1787
+ # Information about the United States driver's license used for identification.
1788
+ # Required if `method` is equal to `drivers_license`.
1789
+ sig do
1790
+ returns(
1791
+ T.nilable(
1792
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::DriversLicense
1793
+ )
1794
+ )
1795
+ end
1796
+ attr_reader :drivers_license
1797
+
1798
+ sig do
1799
+ params(
1800
+ drivers_license:
1801
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::DriversLicense::OrHash
1802
+ ).void
1803
+ end
1804
+ attr_writer :drivers_license
1805
+
1806
+ # Information about the identification document provided. Required if `method` is
1807
+ # equal to `other`.
1808
+ sig do
1809
+ returns(
1810
+ T.nilable(
1811
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Other
1812
+ )
1813
+ )
1814
+ end
1815
+ attr_reader :other
1816
+
1817
+ sig do
1818
+ params(
1819
+ other:
1820
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Other::OrHash
1821
+ ).void
1822
+ end
1823
+ attr_writer :other
1824
+
1825
+ # Information about the passport used for identification. Required if `method` is
1826
+ # equal to `passport`.
1827
+ sig do
1828
+ returns(
1829
+ T.nilable(
1830
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Passport
1831
+ )
1832
+ )
1833
+ end
1834
+ attr_reader :passport
1835
+
1836
+ sig do
1837
+ params(
1838
+ passport:
1839
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Passport::OrHash
1840
+ ).void
1841
+ end
1842
+ attr_writer :passport
1843
+
1844
+ # A means of verifying the sole proprietor's identity. Unlike at creation, an
1845
+ # identity document is accepted here.
1846
+ sig do
1847
+ params(
1848
+ method_:
1849
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::OrSymbol,
1850
+ number: String,
1851
+ drivers_license:
1852
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::DriversLicense::OrHash,
1853
+ other:
1854
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Other::OrHash,
1855
+ passport:
1856
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Passport::OrHash
1857
+ ).returns(T.attached_class)
1858
+ end
1859
+ def self.new(
1860
+ # A method that can be used to verify the individual's identity.
1861
+ #
1862
+ # Defaults to `social_security_number`.
1863
+ method_:,
1864
+ # An identification number that can be used to verify the individual's identity,
1865
+ # such as a social security number. For Social Security Numbers and Individual
1866
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1867
+ # separators.
1868
+ number:,
1869
+ # Information about the United States driver's license used for identification.
1870
+ # Required if `method` is equal to `drivers_license`.
1871
+ drivers_license: nil,
1872
+ # Information about the identification document provided. Required if `method` is
1873
+ # equal to `other`.
1874
+ other: nil,
1875
+ # Information about the passport used for identification. Required if `method` is
1876
+ # equal to `passport`.
1877
+ passport: nil
1878
+ )
1879
+ end
1880
+
1881
+ sig do
1882
+ override.returns(
1883
+ {
1884
+ method_:
1885
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::OrSymbol,
1886
+ number: String,
1887
+ drivers_license:
1888
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::DriversLicense,
1889
+ other:
1890
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Other,
1891
+ passport:
1892
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Passport
1893
+ }
1894
+ )
1895
+ end
1896
+ def to_hash
1897
+ end
1898
+
1899
+ # A method that can be used to verify the individual's identity.
1900
+ #
1901
+ # Defaults to `social_security_number`.
1902
+ module Method
1903
+ extend Increase::Internal::Type::Enum
1904
+
1905
+ TaggedSymbol =
1906
+ T.type_alias do
1907
+ T.all(
1908
+ Symbol,
1909
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method
1910
+ )
1911
+ end
1912
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1913
+
1914
+ # A social security number.
1915
+ SOCIAL_SECURITY_NUMBER =
1916
+ T.let(
1917
+ :social_security_number,
1918
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1919
+ )
1920
+
1921
+ # An individual taxpayer identification number (ITIN).
1922
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
1923
+ T.let(
1924
+ :individual_taxpayer_identification_number,
1925
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1926
+ )
1927
+
1928
+ # A passport number.
1929
+ PASSPORT =
1930
+ T.let(
1931
+ :passport,
1932
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1933
+ )
1934
+
1935
+ # A driver's license number.
1936
+ DRIVERS_LICENSE =
1937
+ T.let(
1938
+ :drivers_license,
1939
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1940
+ )
1941
+
1942
+ # Another identifying document.
1943
+ OTHER =
1944
+ T.let(
1945
+ :other,
1946
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1947
+ )
1948
+
1949
+ sig do
1950
+ override.returns(
1951
+ T::Array[
1952
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
1953
+ ]
1954
+ )
1955
+ end
1956
+ def self.values
1957
+ end
1958
+ end
1959
+
1960
+ class DriversLicense < Increase::Internal::Type::BaseModel
1961
+ OrHash =
1962
+ T.type_alias do
1963
+ T.any(
1964
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::DriversLicense,
1965
+ Increase::Internal::AnyHash
1966
+ )
1967
+ end
1968
+
1969
+ # The driver's license's expiration date in YYYY-MM-DD format.
1970
+ sig { returns(Date) }
1971
+ attr_accessor :expiration_date
1972
+
1973
+ # The identifier of the File containing the front of the driver's license.
1974
+ sig { returns(String) }
1975
+ attr_accessor :file_id
1976
+
1977
+ # The state that issued the provided driver's license.
1978
+ sig { returns(String) }
1979
+ attr_accessor :state
1980
+
1981
+ # The identifier of the File containing the back of the driver's license.
1982
+ sig { returns(T.nilable(String)) }
1983
+ attr_reader :back_file_id
1984
+
1985
+ sig { params(back_file_id: String).void }
1986
+ attr_writer :back_file_id
1987
+
1988
+ # Information about the United States driver's license used for identification.
1989
+ # Required if `method` is equal to `drivers_license`.
1990
+ sig do
1991
+ params(
1992
+ expiration_date: Date,
1993
+ file_id: String,
1994
+ state: String,
1995
+ back_file_id: String
1996
+ ).returns(T.attached_class)
1997
+ end
1998
+ def self.new(
1999
+ # The driver's license's expiration date in YYYY-MM-DD format.
2000
+ expiration_date:,
2001
+ # The identifier of the File containing the front of the driver's license.
2002
+ file_id:,
2003
+ # The state that issued the provided driver's license.
2004
+ state:,
2005
+ # The identifier of the File containing the back of the driver's license.
2006
+ back_file_id: nil
2007
+ )
2008
+ end
2009
+
2010
+ sig do
2011
+ override.returns(
2012
+ {
2013
+ expiration_date: Date,
2014
+ file_id: String,
2015
+ state: String,
2016
+ back_file_id: String
2017
+ }
2018
+ )
2019
+ end
2020
+ def to_hash
2021
+ end
2022
+ end
2023
+
2024
+ class Other < Increase::Internal::Type::BaseModel
2025
+ OrHash =
2026
+ T.type_alias do
2027
+ T.any(
2028
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Other,
2029
+ Increase::Internal::AnyHash
2030
+ )
2031
+ end
2032
+
2033
+ # The two-character ISO 3166-1 code representing the country that issued the
2034
+ # document (e.g., `US`).
2035
+ sig { returns(String) }
2036
+ attr_accessor :country
2037
+
2038
+ # A description of the document submitted.
2039
+ sig { returns(String) }
2040
+ attr_accessor :description
2041
+
2042
+ # The identifier of the File containing the front of the document.
2043
+ sig { returns(String) }
2044
+ attr_accessor :file_id
2045
+
2046
+ # The identifier of the File containing the back of the document. Not every
2047
+ # document has a reverse side.
2048
+ sig { returns(T.nilable(String)) }
2049
+ attr_reader :back_file_id
2050
+
2051
+ sig { params(back_file_id: String).void }
2052
+ attr_writer :back_file_id
2053
+
2054
+ # The document's expiration date in YYYY-MM-DD format.
2055
+ sig { returns(T.nilable(Date)) }
2056
+ attr_reader :expiration_date
2057
+
2058
+ sig { params(expiration_date: Date).void }
2059
+ attr_writer :expiration_date
2060
+
2061
+ # Information about the identification document provided. Required if `method` is
2062
+ # equal to `other`.
2063
+ sig do
2064
+ params(
2065
+ country: String,
2066
+ description: String,
2067
+ file_id: String,
2068
+ back_file_id: String,
2069
+ expiration_date: Date
2070
+ ).returns(T.attached_class)
2071
+ end
2072
+ def self.new(
2073
+ # The two-character ISO 3166-1 code representing the country that issued the
2074
+ # document (e.g., `US`).
2075
+ country:,
2076
+ # A description of the document submitted.
2077
+ description:,
2078
+ # The identifier of the File containing the front of the document.
2079
+ file_id:,
2080
+ # The identifier of the File containing the back of the document. Not every
2081
+ # document has a reverse side.
2082
+ back_file_id: nil,
2083
+ # The document's expiration date in YYYY-MM-DD format.
2084
+ expiration_date: nil
2085
+ )
2086
+ end
2087
+
2088
+ sig do
2089
+ override.returns(
2090
+ {
2091
+ country: String,
2092
+ description: String,
2093
+ file_id: String,
2094
+ back_file_id: String,
2095
+ expiration_date: Date
2096
+ }
2097
+ )
2098
+ end
2099
+ def to_hash
2100
+ end
2101
+ end
2102
+
2103
+ class Passport < Increase::Internal::Type::BaseModel
2104
+ OrHash =
2105
+ T.type_alias do
2106
+ T.any(
2107
+ Increase::EntityUpdateParams::SoleProprietorship::SoleProprietor::Identification::Passport,
2108
+ Increase::Internal::AnyHash
2109
+ )
2110
+ end
2111
+
2112
+ # The two-character ISO 3166-1 code representing the country that issued the
2113
+ # document (e.g., `US`).
2114
+ sig { returns(String) }
2115
+ attr_accessor :country
2116
+
2117
+ # The passport's expiration date in YYYY-MM-DD format.
2118
+ sig { returns(Date) }
2119
+ attr_accessor :expiration_date
2120
+
2121
+ # The identifier of the File containing the passport.
2122
+ sig { returns(String) }
2123
+ attr_accessor :file_id
2124
+
2125
+ # Information about the passport used for identification. Required if `method` is
2126
+ # equal to `passport`.
2127
+ sig do
2128
+ params(
2129
+ country: String,
2130
+ expiration_date: Date,
2131
+ file_id: String
2132
+ ).returns(T.attached_class)
2133
+ end
2134
+ def self.new(
2135
+ # The two-character ISO 3166-1 code representing the country that issued the
2136
+ # document (e.g., `US`).
2137
+ country:,
2138
+ # The passport's expiration date in YYYY-MM-DD format.
2139
+ expiration_date:,
2140
+ # The identifier of the File containing the passport.
2141
+ file_id:
2142
+ )
2143
+ end
2144
+
2145
+ sig do
2146
+ override.returns(
2147
+ { country: String, expiration_date: Date, file_id: String }
2148
+ )
2149
+ end
2150
+ def to_hash
2151
+ end
2152
+ end
2153
+ end
2154
+ end
2155
+ end
2156
+
1353
2157
  class TermsAgreement < Increase::Internal::Type::BaseModel
1354
2158
  OrHash =
1355
2159
  T.type_alias do
@@ -1363,7 +2167,7 @@ module Increase
1363
2167
  sig { returns(Time) }
1364
2168
  attr_accessor :agreed_at
1365
2169
 
1366
- # The IP address the Entity accessed reviewed the terms from.
2170
+ # The IP address the Entity reviewed the terms from.
1367
2171
  sig { returns(String) }
1368
2172
  attr_accessor :ip_address
1369
2173
 
@@ -1381,7 +2185,7 @@ module Increase
1381
2185
  def self.new(
1382
2186
  # The timestamp of when the Entity agreed to the terms.
1383
2187
  agreed_at:,
1384
- # The IP address the Entity accessed reviewed the terms from.
2188
+ # The IP address the Entity reviewed the terms from.
1385
2189
  ip_address:,
1386
2190
  # The URL of the terms agreement. This link will be provided by your bank partner.
1387
2191
  terms_url:
@@ -1894,8 +2698,7 @@ module Increase
1894
2698
  # An identification number that can be used to verify the individual's identity,
1895
2699
  # such as a social security number. For Social Security Numbers and Individual
1896
2700
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1897
- # separators. When testing in sandbox, use one of our
1898
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2701
+ # separators.
1899
2702
  sig { returns(String) }
1900
2703
  attr_accessor :number
1901
2704
 
@@ -1978,8 +2781,7 @@ module Increase
1978
2781
  # An identification number that can be used to verify the individual's identity,
1979
2782
  # such as a social security number. For Social Security Numbers and Individual
1980
2783
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1981
- # separators. When testing in sandbox, use one of our
1982
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
2784
+ # separators.
1983
2785
  number:,
1984
2786
  # Information about the United States driver's license used for identification.
1985
2787
  # Required if `method` is equal to `drivers_license`.
@@ -2586,8 +3388,7 @@ module Increase
2586
3388
  # An identification number that can be used to verify the individual's identity,
2587
3389
  # such as a social security number. For Social Security Numbers and Individual
2588
3390
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2589
- # separators. When testing in sandbox, use one of our
2590
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3391
+ # separators.
2591
3392
  sig { returns(String) }
2592
3393
  attr_accessor :number
2593
3394
 
@@ -2670,8 +3471,7 @@ module Increase
2670
3471
  # An identification number that can be used to verify the individual's identity,
2671
3472
  # such as a social security number. For Social Security Numbers and Individual
2672
3473
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
2673
- # separators. When testing in sandbox, use one of our
2674
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
3474
+ # separators.
2675
3475
  number:,
2676
3476
  # Information about the United States driver's license used for identification.
2677
3477
  # Required if `method` is equal to `drivers_license`.