increase 1.271.0 → 1.273.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 (15) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +175 -0
  3. data/README.md +1 -1
  4. data/lib/increase/internal/util.rb +1 -2
  5. data/lib/increase/models/entity.rb +147 -91
  6. data/lib/increase/models/entity_create_params.rb +130 -90
  7. data/lib/increase/models/entity_update_params.rb +52 -36
  8. data/lib/increase/version.rb +1 -1
  9. data/rbi/increase/models/entity.rbi +175 -119
  10. data/rbi/increase/models/entity_create_params.rbi +175 -105
  11. data/rbi/increase/models/entity_update_params.rbi +70 -42
  12. data/sig/increase/models/entity.rbs +119 -84
  13. data/sig/increase/models/entity_create_params.rbs +100 -55
  14. data/sig/increase/models/entity_update_params.rbs +40 -22
  15. metadata +2 -2
data/lib/increase/models/entity.rb CHANGED
@@ -252,10 +252,16 @@ module Increase
252
252
  # @see Increase::Models::Entity::Corporation#address
253
253
  class Address < Increase::Internal::Type::BaseModel
254
254
  # @!attribute city
255
- # The city of the address.
255
+ # The city, district, town, or village of the address.
256
+ #
257
+ # @return [String, nil]
258
+ required :city, String, nil?: true
259
+
260
+ # @!attribute country
261
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
256
262
  #
257
263
  # @return [String]
258
- required :city, String
264
+ required :country, String
259
265
 
260
266
  # @!attribute line1
261
267
  # The first line of the address.
@@ -270,33 +276,35 @@ module Increase
270
276
  required :line2, String, nil?: true
271
277
 
272
278
  # @!attribute state
273
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
274
- # the address.
279
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
280
+ # state, province, or region of the address.
275
281
  #
276
- # @return [String]
277
- required :state, String
282
+ # @return [String, nil]
283
+ required :state, String, nil?: true
278
284
 
279
285
  # @!attribute zip
280
- # The ZIP code of the address.
286
+ # The ZIP or postal code of the address.
281
287
  #
282
- # @return [String]
283
- required :zip, String
288
+ # @return [String, nil]
289
+ required :zip, String, nil?: true
284
290
 
285
- # @!method initialize(city:, line1:, line2:, state:, zip:)
291
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
286
292
  # Some parameter documentations has been truncated, see
287
293
  # {Increase::Models::Entity::Corporation::Address} for more details.
288
294
  #
289
295
  # The corporation's address.
290
296
  #
291
- # @param city [String] The city of the address.
297
+ # @param city [String, nil] The city, district, town, or village of the address.
298
+ #
299
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
292
300
  #
293
301
  # @param line1 [String] The first line of the address.
294
302
  #
295
303
  # @param line2 [String, nil] The second line of the address.
296
304
  #
297
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
305
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
298
306
  #
299
- # @param zip [String] The ZIP code of the address.
307
+ # @param zip [String, nil] The ZIP or postal code of the address.
300
308
  end
301
309
 
302
310
  class BeneficialOwner < Increase::Internal::Type::BaseModel
@@ -599,10 +607,16 @@ module Increase
599
607
  # @see Increase::Models::Entity::GovernmentAuthority#address
600
608
  class Address < Increase::Internal::Type::BaseModel
601
609
  # @!attribute city
602
- # The city of the address.
610
+ # The city, district, town, or village of the address.
611
+ #
612
+ # @return [String, nil]
613
+ required :city, String, nil?: true
614
+
615
+ # @!attribute country
616
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
603
617
  #
604
618
  # @return [String]
605
- required :city, String
619
+ required :country, String
606
620
 
607
621
  # @!attribute line1
608
622
  # The first line of the address.
@@ -617,33 +631,35 @@ module Increase
617
631
  required :line2, String, nil?: true
618
632
 
619
633
  # @!attribute state
620
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
621
- # the address.
634
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
635
+ # state, province, or region of the address.
622
636
  #
623
- # @return [String]
624
- required :state, String
637
+ # @return [String, nil]
638
+ required :state, String, nil?: true
625
639
 
626
640
  # @!attribute zip
627
- # The ZIP code of the address.
641
+ # The ZIP or postal code of the address.
628
642
  #
629
- # @return [String]
630
- required :zip, String
643
+ # @return [String, nil]
644
+ required :zip, String, nil?: true
631
645
 
632
- # @!method initialize(city:, line1:, line2:, state:, zip:)
646
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
633
647
  # Some parameter documentations has been truncated, see
634
648
  # {Increase::Models::Entity::GovernmentAuthority::Address} for more details.
635
649
  #
636
650
  # The government authority's address.
637
651
  #
638
- # @param city [String] The city of the address.
652
+ # @param city [String, nil] The city, district, town, or village of the address.
653
+ #
654
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
639
655
  #
640
656
  # @param line1 [String] The first line of the address.
641
657
  #
642
658
  # @param line2 [String, nil] The second line of the address.
643
659
  #
644
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
660
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
645
661
  #
646
- # @param zip [String] The ZIP code of the address.
662
+ # @param zip [String, nil] The ZIP or postal code of the address.
647
663
  end
648
664
 
649
665
  class AuthorizedPerson < Increase::Internal::Type::BaseModel
@@ -746,10 +762,16 @@ module Increase
746
762
  # @see Increase::Models::Entity::Joint::Individual#address
747
763
  class Address < Increase::Internal::Type::BaseModel
748
764
  # @!attribute city
749
- # The city of the address.
765
+ # The city, district, town, or village of the address.
766
+ #
767
+ # @return [String, nil]
768
+ required :city, String, nil?: true
769
+
770
+ # @!attribute country
771
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
750
772
  #
751
773
  # @return [String]
752
- required :city, String
774
+ required :country, String
753
775
 
754
776
  # @!attribute line1
755
777
  # The first line of the address.
@@ -764,33 +786,35 @@ module Increase
764
786
  required :line2, String, nil?: true
765
787
 
766
788
  # @!attribute state
767
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
768
- # the address.
789
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
790
+ # state, province, or region of the address.
769
791
  #
770
- # @return [String]
771
- required :state, String
792
+ # @return [String, nil]
793
+ required :state, String, nil?: true
772
794
 
773
795
  # @!attribute zip
774
- # The ZIP code of the address.
796
+ # The ZIP or postal code of the address.
775
797
  #
776
- # @return [String]
777
- required :zip, String
798
+ # @return [String, nil]
799
+ required :zip, String, nil?: true
778
800
 
779
- # @!method initialize(city:, line1:, line2:, state:, zip:)
801
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
780
802
  # Some parameter documentations has been truncated, see
781
803
  # {Increase::Models::Entity::Joint::Individual::Address} for more details.
782
804
  #
783
805
  # The person's address.
784
806
  #
785
- # @param city [String] The city of the address.
807
+ # @param city [String, nil] The city, district, town, or village of the address.
808
+ #
809
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
786
810
  #
787
811
  # @param line1 [String] The first line of the address.
788
812
  #
789
813
  # @param line2 [String, nil] The second line of the address.
790
814
  #
791
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
815
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
792
816
  #
793
- # @param zip [String] The ZIP code of the address.
817
+ # @param zip [String, nil] The ZIP or postal code of the address.
794
818
  end
795
819
 
796
820
  # @see Increase::Models::Entity::Joint::Individual#identification
@@ -889,10 +913,16 @@ module Increase
889
913
  # @see Increase::Models::Entity::NaturalPerson#address
890
914
  class Address < Increase::Internal::Type::BaseModel
891
915
  # @!attribute city
892
- # The city of the address.
916
+ # The city, district, town, or village of the address.
917
+ #
918
+ # @return [String, nil]
919
+ required :city, String, nil?: true
920
+
921
+ # @!attribute country
922
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
893
923
  #
894
924
  # @return [String]
895
- required :city, String
925
+ required :country, String
896
926
 
897
927
  # @!attribute line1
898
928
  # The first line of the address.
@@ -907,33 +937,35 @@ module Increase
907
937
  required :line2, String, nil?: true
908
938
 
909
939
  # @!attribute state
910
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
911
- # the address.
940
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
941
+ # state, province, or region of the address.
912
942
  #
913
- # @return [String]
914
- required :state, String
943
+ # @return [String, nil]
944
+ required :state, String, nil?: true
915
945
 
916
946
  # @!attribute zip
917
- # The ZIP code of the address.
947
+ # The ZIP or postal code of the address.
918
948
  #
919
- # @return [String]
920
- required :zip, String
949
+ # @return [String, nil]
950
+ required :zip, String, nil?: true
921
951
 
922
- # @!method initialize(city:, line1:, line2:, state:, zip:)
952
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
923
953
  # Some parameter documentations has been truncated, see
924
954
  # {Increase::Models::Entity::NaturalPerson::Address} for more details.
925
955
  #
926
956
  # The person's address.
927
957
  #
928
- # @param city [String] The city of the address.
958
+ # @param city [String, nil] The city, district, town, or village of the address.
959
+ #
960
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
929
961
  #
930
962
  # @param line1 [String] The first line of the address.
931
963
  #
932
964
  # @param line2 [String, nil] The second line of the address.
933
965
  #
934
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
966
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
935
967
  #
936
- # @param zip [String] The ZIP code of the address.
968
+ # @param zip [String, nil] The ZIP or postal code of the address.
937
969
  end
938
970
 
939
971
  # @see Increase::Models::Entity::NaturalPerson#identification
@@ -1237,10 +1269,16 @@ module Increase
1237
1269
  # @see Increase::Models::Entity::Trust#address
1238
1270
  class Address < Increase::Internal::Type::BaseModel
1239
1271
  # @!attribute city
1240
- # The city of the address.
1272
+ # The city, district, town, or village of the address.
1273
+ #
1274
+ # @return [String, nil]
1275
+ required :city, String, nil?: true
1276
+
1277
+ # @!attribute country
1278
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1241
1279
  #
1242
1280
  # @return [String]
1243
- required :city, String
1281
+ required :country, String
1244
1282
 
1245
1283
  # @!attribute line1
1246
1284
  # The first line of the address.
@@ -1255,33 +1293,35 @@ module Increase
1255
1293
  required :line2, String, nil?: true
1256
1294
 
1257
1295
  # @!attribute state
1258
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1259
- # the address.
1296
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1297
+ # state, province, or region of the address.
1260
1298
  #
1261
- # @return [String]
1262
- required :state, String
1299
+ # @return [String, nil]
1300
+ required :state, String, nil?: true
1263
1301
 
1264
1302
  # @!attribute zip
1265
- # The ZIP code of the address.
1303
+ # The ZIP or postal code of the address.
1266
1304
  #
1267
- # @return [String]
1268
- required :zip, String
1305
+ # @return [String, nil]
1306
+ required :zip, String, nil?: true
1269
1307
 
1270
- # @!method initialize(city:, line1:, line2:, state:, zip:)
1308
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1271
1309
  # Some parameter documentations has been truncated, see
1272
1310
  # {Increase::Models::Entity::Trust::Address} for more details.
1273
1311
  #
1274
1312
  # The trust's address.
1275
1313
  #
1276
- # @param city [String] The city of the address.
1314
+ # @param city [String, nil] The city, district, town, or village of the address.
1315
+ #
1316
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1277
1317
  #
1278
1318
  # @param line1 [String] The first line of the address.
1279
1319
  #
1280
1320
  # @param line2 [String, nil] The second line of the address.
1281
1321
  #
1282
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1322
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1283
1323
  #
1284
- # @param zip [String] The ZIP code of the address.
1324
+ # @param zip [String, nil] The ZIP or postal code of the address.
1285
1325
  end
1286
1326
 
1287
1327
  # Whether the trust is `revocable` or `irrevocable`.
@@ -1340,10 +1380,16 @@ module Increase
1340
1380
  # @see Increase::Models::Entity::Trust::Grantor#address
1341
1381
  class Address < Increase::Internal::Type::BaseModel
1342
1382
  # @!attribute city
1343
- # The city of the address.
1383
+ # The city, district, town, or village of the address.
1384
+ #
1385
+ # @return [String, nil]
1386
+ required :city, String, nil?: true
1387
+
1388
+ # @!attribute country
1389
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1344
1390
  #
1345
1391
  # @return [String]
1346
- required :city, String
1392
+ required :country, String
1347
1393
 
1348
1394
  # @!attribute line1
1349
1395
  # The first line of the address.
@@ -1358,33 +1404,35 @@ module Increase
1358
1404
  required :line2, String, nil?: true
1359
1405
 
1360
1406
  # @!attribute state
1361
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1362
- # the address.
1407
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1408
+ # state, province, or region of the address.
1363
1409
  #
1364
- # @return [String]
1365
- required :state, String
1410
+ # @return [String, nil]
1411
+ required :state, String, nil?: true
1366
1412
 
1367
1413
  # @!attribute zip
1368
- # The ZIP code of the address.
1414
+ # The ZIP or postal code of the address.
1369
1415
  #
1370
- # @return [String]
1371
- required :zip, String
1416
+ # @return [String, nil]
1417
+ required :zip, String, nil?: true
1372
1418
 
1373
- # @!method initialize(city:, line1:, line2:, state:, zip:)
1419
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1374
1420
  # Some parameter documentations has been truncated, see
1375
1421
  # {Increase::Models::Entity::Trust::Grantor::Address} for more details.
1376
1422
  #
1377
1423
  # The person's address.
1378
1424
  #
1379
- # @param city [String] The city of the address.
1425
+ # @param city [String, nil] The city, district, town, or village of the address.
1426
+ #
1427
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1380
1428
  #
1381
1429
  # @param line1 [String] The first line of the address.
1382
1430
  #
1383
1431
  # @param line2 [String, nil] The second line of the address.
1384
1432
  #
1385
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1433
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1386
1434
  #
1387
- # @param zip [String] The ZIP code of the address.
1435
+ # @param zip [String, nil] The ZIP or postal code of the address.
1388
1436
  end
1389
1437
 
1390
1438
  # @see Increase::Models::Entity::Trust::Grantor#identification
@@ -1504,10 +1552,16 @@ module Increase
1504
1552
  # @see Increase::Models::Entity::Trust::Trustee::Individual#address
1505
1553
  class Address < Increase::Internal::Type::BaseModel
1506
1554
  # @!attribute city
1507
- # The city of the address.
1555
+ # The city, district, town, or village of the address.
1556
+ #
1557
+ # @return [String, nil]
1558
+ required :city, String, nil?: true
1559
+
1560
+ # @!attribute country
1561
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1508
1562
  #
1509
1563
  # @return [String]
1510
- required :city, String
1564
+ required :country, String
1511
1565
 
1512
1566
  # @!attribute line1
1513
1567
  # The first line of the address.
@@ -1522,34 +1576,36 @@ module Increase
1522
1576
  required :line2, String, nil?: true
1523
1577
 
1524
1578
  # @!attribute state
1525
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1526
- # the address.
1579
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1580
+ # state, province, or region of the address.
1527
1581
  #
1528
- # @return [String]
1529
- required :state, String
1582
+ # @return [String, nil]
1583
+ required :state, String, nil?: true
1530
1584
 
1531
1585
  # @!attribute zip
1532
- # The ZIP code of the address.
1586
+ # The ZIP or postal code of the address.
1533
1587
  #
1534
- # @return [String]
1535
- required :zip, String
1588
+ # @return [String, nil]
1589
+ required :zip, String, nil?: true
1536
1590
 
1537
- # @!method initialize(city:, line1:, line2:, state:, zip:)
1591
+ # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1538
1592
  # Some parameter documentations has been truncated, see
1539
1593
  # {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more
1540
1594
  # details.
1541
1595
  #
1542
1596
  # The person's address.
1543
1597
  #
1544
- # @param city [String] The city of the address.
1598
+ # @param city [String, nil] The city, district, town, or village of the address.
1599
+ #
1600
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1545
1601
  #
1546
1602
  # @param line1 [String] The first line of the address.
1547
1603
  #
1548
1604
  # @param line2 [String, nil] The second line of the address.
1549
1605
  #
1550
- # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1606
+ # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1551
1607
  #
1552
- # @param zip [String] The ZIP code of the address.
1608
+ # @param zip [String, nil] The ZIP or postal code of the address.
1553
1609
  end
1554
1610
 
1555
1611
  # @see Increase::Models::Entity::Trust::Trustee::Individual#identification