increase 1.270.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 +183 -0
  3. data/README.md +1 -1
  4. data/lib/increase/internal/util.rb +1 -2
  5. data/lib/increase/models/entity.rb +194 -100
  6. data/lib/increase/models/entity_create_params.rb +185 -99
  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 +283 -127
  10. data/rbi/increase/models/entity_create_params.rbi +299 -113
  11. data/rbi/increase/models/entity_update_params.rbi +70 -42
  12. data/sig/increase/models/entity.rbs +160 -89
  13. data/sig/increase/models/entity_create_params.rbs +145 -60
  14. data/sig/increase/models/entity_update_params.rbs +40 -22
  15. metadata +2 -2
data/rbi/increase/models/entity.rbi CHANGED
@@ -290,14 +290,24 @@ module Increase
290
290
  sig { returns(T.nilable(String)) }
291
291
  attr_accessor :industry_code
292
292
 
293
+ # The legal identifier of the corporation.
294
+ sig do
295
+ returns(T.nilable(Increase::Entity::Corporation::LegalIdentifier))
296
+ end
297
+ attr_reader :legal_identifier
298
+
299
+ sig do
300
+ params(
301
+ legal_identifier:
302
+ T.nilable(Increase::Entity::Corporation::LegalIdentifier::OrHash)
303
+ ).void
304
+ end
305
+ attr_writer :legal_identifier
306
+
293
307
  # The legal name of the corporation.
294
308
  sig { returns(String) }
295
309
  attr_accessor :name
296
310
 
297
- # The Employer Identification Number (EIN) for the corporation.
298
- sig { returns(T.nilable(String)) }
299
- attr_accessor :tax_identifier
300
-
301
311
  # The website of the corporation.
302
312
  sig { returns(T.nilable(String)) }
303
313
  attr_accessor :website
@@ -312,8 +322,9 @@ module Increase
312
322
  email: T.nilable(String),
313
323
  incorporation_state: T.nilable(String),
314
324
  industry_code: T.nilable(String),
325
+ legal_identifier:
326
+ T.nilable(Increase::Entity::Corporation::LegalIdentifier::OrHash),
315
327
  name: String,
316
- tax_identifier: T.nilable(String),
317
328
  website: T.nilable(String)
318
329
  ).returns(T.attached_class)
319
330
  end
@@ -331,10 +342,10 @@ module Increase
331
342
  # The numeric North American Industry Classification System (NAICS) code submitted
332
343
  # for the corporation.
333
344
  industry_code:,
345
+ # The legal identifier of the corporation.
346
+ legal_identifier:,
334
347
  # The legal name of the corporation.
335
348
  name:,
336
- # The Employer Identification Number (EIN) for the corporation.
337
- tax_identifier:,
338
349
  # The website of the corporation.
339
350
  website:
340
351
  )
@@ -349,8 +360,9 @@ module Increase
349
360
  email: T.nilable(String),
350
361
  incorporation_state: T.nilable(String),
351
362
  industry_code: T.nilable(String),
363
+ legal_identifier:
364
+ T.nilable(Increase::Entity::Corporation::LegalIdentifier),
352
365
  name: String,
353
- tax_identifier: T.nilable(String),
354
366
  website: T.nilable(String)
355
367
  }
356
368
  )
@@ -367,10 +379,14 @@ module Increase
367
379
  )
368
380
  end
369
381
 
370
- # The city of the address.
371
- sig { returns(String) }
382
+ # The city, district, town, or village of the address.
383
+ sig { returns(T.nilable(String)) }
372
384
  attr_accessor :city
373
385
 
386
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
387
+ sig { returns(String) }
388
+ attr_accessor :country
389
+
374
390
  # The first line of the address.
375
391
  sig { returns(String) }
376
392
  attr_accessor :line1
@@ -379,36 +395,39 @@ module Increase
379
395
  sig { returns(T.nilable(String)) }
380
396
  attr_accessor :line2
381
397
 
382
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
383
- # the address.
384
- sig { returns(String) }
398
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
399
+ # state, province, or region of the address.
400
+ sig { returns(T.nilable(String)) }
385
401
  attr_accessor :state
386
402
 
387
- # The ZIP code of the address.
388
- sig { returns(String) }
403
+ # The ZIP or postal code of the address.
404
+ sig { returns(T.nilable(String)) }
389
405
  attr_accessor :zip
390
406
 
391
407
  # The corporation's address.
392
408
  sig do
393
409
  params(
394
- city: String,
410
+ city: T.nilable(String),
411
+ country: String,
395
412
  line1: String,
396
413
  line2: T.nilable(String),
397
- state: String,
398
- zip: String
414
+ state: T.nilable(String),
415
+ zip: T.nilable(String)
399
416
  ).returns(T.attached_class)
400
417
  end
401
418
  def self.new(
402
- # The city of the address.
419
+ # The city, district, town, or village of the address.
403
420
  city:,
421
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
422
+ country:,
404
423
  # The first line of the address.
405
424
  line1:,
406
425
  # The second line of the address.
407
426
  line2:,
408
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
409
- # the address.
427
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
428
+ # state, province, or region of the address.
410
429
  state:,
411
- # The ZIP code of the address.
430
+ # The ZIP or postal code of the address.
412
431
  zip:
413
432
  )
414
433
  end
@@ -416,11 +435,12 @@ module Increase
416
435
  sig do
417
436
  override.returns(
418
437
  {
419
- city: String,
438
+ city: T.nilable(String),
439
+ country: String,
420
440
  line1: String,
421
441
  line2: T.nilable(String),
422
- state: String,
423
- zip: String
442
+ state: T.nilable(String),
443
+ zip: T.nilable(String)
424
444
  }
425
445
  )
426
446
  end
@@ -824,6 +844,94 @@ module Increase
824
844
  end
825
845
  end
826
846
  end
847
+
848
+ class LegalIdentifier < Increase::Internal::Type::BaseModel
849
+ OrHash =
850
+ T.type_alias do
851
+ T.any(
852
+ Increase::Entity::Corporation::LegalIdentifier,
853
+ Increase::Internal::AnyHash
854
+ )
855
+ end
856
+
857
+ # The category of the legal identifier.
858
+ sig do
859
+ returns(
860
+ Increase::Entity::Corporation::LegalIdentifier::Category::TaggedSymbol
861
+ )
862
+ end
863
+ attr_accessor :category
864
+
865
+ # The identifier of the legal identifier.
866
+ sig { returns(String) }
867
+ attr_accessor :value
868
+
869
+ # The legal identifier of the corporation.
870
+ sig do
871
+ params(
872
+ category:
873
+ Increase::Entity::Corporation::LegalIdentifier::Category::OrSymbol,
874
+ value: String
875
+ ).returns(T.attached_class)
876
+ end
877
+ def self.new(
878
+ # The category of the legal identifier.
879
+ category:,
880
+ # The identifier of the legal identifier.
881
+ value:
882
+ )
883
+ end
884
+
885
+ sig do
886
+ override.returns(
887
+ {
888
+ category:
889
+ Increase::Entity::Corporation::LegalIdentifier::Category::TaggedSymbol,
890
+ value: String
891
+ }
892
+ )
893
+ end
894
+ def to_hash
895
+ end
896
+
897
+ # The category of the legal identifier.
898
+ module Category
899
+ extend Increase::Internal::Type::Enum
900
+
901
+ TaggedSymbol =
902
+ T.type_alias do
903
+ T.all(
904
+ Symbol,
905
+ Increase::Entity::Corporation::LegalIdentifier::Category
906
+ )
907
+ end
908
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
909
+
910
+ # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
911
+ US_EMPLOYER_IDENTIFICATION_NUMBER =
912
+ T.let(
913
+ :us_employer_identification_number,
914
+ Increase::Entity::Corporation::LegalIdentifier::Category::TaggedSymbol
915
+ )
916
+
917
+ # A legal identifier issued by a foreign government, like a tax identification number or registration number.
918
+ OTHER =
919
+ T.let(
920
+ :other,
921
+ Increase::Entity::Corporation::LegalIdentifier::Category::TaggedSymbol
922
+ )
923
+
924
+ sig do
925
+ override.returns(
926
+ T::Array[
927
+ Increase::Entity::Corporation::LegalIdentifier::Category::TaggedSymbol
928
+ ]
929
+ )
930
+ end
931
+ def self.values
932
+ end
933
+ end
934
+ end
827
935
  end
828
936
 
829
937
  class GovernmentAuthority < Increase::Internal::Type::BaseModel
@@ -931,10 +1039,14 @@ module Increase
931
1039
  )
932
1040
  end
933
1041
 
934
- # The city of the address.
935
- sig { returns(String) }
1042
+ # The city, district, town, or village of the address.
1043
+ sig { returns(T.nilable(String)) }
936
1044
  attr_accessor :city
937
1045
 
1046
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1047
+ sig { returns(String) }
1048
+ attr_accessor :country
1049
+
938
1050
  # The first line of the address.
939
1051
  sig { returns(String) }
940
1052
  attr_accessor :line1
@@ -943,36 +1055,39 @@ module Increase
943
1055
  sig { returns(T.nilable(String)) }
944
1056
  attr_accessor :line2
945
1057
 
946
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
947
- # the address.
948
- sig { returns(String) }
1058
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1059
+ # state, province, or region of the address.
1060
+ sig { returns(T.nilable(String)) }
949
1061
  attr_accessor :state
950
1062
 
951
- # The ZIP code of the address.
952
- sig { returns(String) }
1063
+ # The ZIP or postal code of the address.
1064
+ sig { returns(T.nilable(String)) }
953
1065
  attr_accessor :zip
954
1066
 
955
1067
  # The government authority's address.
956
1068
  sig do
957
1069
  params(
958
- city: String,
1070
+ city: T.nilable(String),
1071
+ country: String,
959
1072
  line1: String,
960
1073
  line2: T.nilable(String),
961
- state: String,
962
- zip: String
1074
+ state: T.nilable(String),
1075
+ zip: T.nilable(String)
963
1076
  ).returns(T.attached_class)
964
1077
  end
965
1078
  def self.new(
966
- # The city of the address.
1079
+ # The city, district, town, or village of the address.
967
1080
  city:,
1081
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1082
+ country:,
968
1083
  # The first line of the address.
969
1084
  line1:,
970
1085
  # The second line of the address.
971
1086
  line2:,
972
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
973
- # the address.
1087
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1088
+ # state, province, or region of the address.
974
1089
  state:,
975
- # The ZIP code of the address.
1090
+ # The ZIP or postal code of the address.
976
1091
  zip:
977
1092
  )
978
1093
  end
@@ -980,11 +1095,12 @@ module Increase
980
1095
  sig do
981
1096
  override.returns(
982
1097
  {
983
- city: String,
1098
+ city: T.nilable(String),
1099
+ country: String,
984
1100
  line1: String,
985
1101
  line2: T.nilable(String),
986
- state: String,
987
- zip: String
1102
+ state: T.nilable(String),
1103
+ zip: T.nilable(String)
988
1104
  }
989
1105
  )
990
1106
  end
@@ -1203,10 +1319,14 @@ module Increase
1203
1319
  )
1204
1320
  end
1205
1321
 
1206
- # The city of the address.
1207
- sig { returns(String) }
1322
+ # The city, district, town, or village of the address.
1323
+ sig { returns(T.nilable(String)) }
1208
1324
  attr_accessor :city
1209
1325
 
1326
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1327
+ sig { returns(String) }
1328
+ attr_accessor :country
1329
+
1210
1330
  # The first line of the address.
1211
1331
  sig { returns(String) }
1212
1332
  attr_accessor :line1
@@ -1215,36 +1335,39 @@ module Increase
1215
1335
  sig { returns(T.nilable(String)) }
1216
1336
  attr_accessor :line2
1217
1337
 
1218
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1219
- # the address.
1220
- sig { returns(String) }
1338
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1339
+ # state, province, or region of the address.
1340
+ sig { returns(T.nilable(String)) }
1221
1341
  attr_accessor :state
1222
1342
 
1223
- # The ZIP code of the address.
1224
- sig { returns(String) }
1343
+ # The ZIP or postal code of the address.
1344
+ sig { returns(T.nilable(String)) }
1225
1345
  attr_accessor :zip
1226
1346
 
1227
1347
  # The person's address.
1228
1348
  sig do
1229
1349
  params(
1230
- city: String,
1350
+ city: T.nilable(String),
1351
+ country: String,
1231
1352
  line1: String,
1232
1353
  line2: T.nilable(String),
1233
- state: String,
1234
- zip: String
1354
+ state: T.nilable(String),
1355
+ zip: T.nilable(String)
1235
1356
  ).returns(T.attached_class)
1236
1357
  end
1237
1358
  def self.new(
1238
- # The city of the address.
1359
+ # The city, district, town, or village of the address.
1239
1360
  city:,
1361
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1362
+ country:,
1240
1363
  # The first line of the address.
1241
1364
  line1:,
1242
1365
  # The second line of the address.
1243
1366
  line2:,
1244
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1245
- # the address.
1367
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1368
+ # state, province, or region of the address.
1246
1369
  state:,
1247
- # The ZIP code of the address.
1370
+ # The ZIP or postal code of the address.
1248
1371
  zip:
1249
1372
  )
1250
1373
  end
@@ -1252,11 +1375,12 @@ module Increase
1252
1375
  sig do
1253
1376
  override.returns(
1254
1377
  {
1255
- city: String,
1378
+ city: T.nilable(String),
1379
+ country: String,
1256
1380
  line1: String,
1257
1381
  line2: T.nilable(String),
1258
- state: String,
1259
- zip: String
1382
+ state: T.nilable(String),
1383
+ zip: T.nilable(String)
1260
1384
  }
1261
1385
  )
1262
1386
  end
@@ -1457,10 +1581,14 @@ module Increase
1457
1581
  )
1458
1582
  end
1459
1583
 
1460
- # The city of the address.
1461
- sig { returns(String) }
1584
+ # The city, district, town, or village of the address.
1585
+ sig { returns(T.nilable(String)) }
1462
1586
  attr_accessor :city
1463
1587
 
1588
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1589
+ sig { returns(String) }
1590
+ attr_accessor :country
1591
+
1464
1592
  # The first line of the address.
1465
1593
  sig { returns(String) }
1466
1594
  attr_accessor :line1
@@ -1469,36 +1597,39 @@ module Increase
1469
1597
  sig { returns(T.nilable(String)) }
1470
1598
  attr_accessor :line2
1471
1599
 
1472
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1473
- # the address.
1474
- sig { returns(String) }
1600
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1601
+ # state, province, or region of the address.
1602
+ sig { returns(T.nilable(String)) }
1475
1603
  attr_accessor :state
1476
1604
 
1477
- # The ZIP code of the address.
1478
- sig { returns(String) }
1605
+ # The ZIP or postal code of the address.
1606
+ sig { returns(T.nilable(String)) }
1479
1607
  attr_accessor :zip
1480
1608
 
1481
1609
  # The person's address.
1482
1610
  sig do
1483
1611
  params(
1484
- city: String,
1612
+ city: T.nilable(String),
1613
+ country: String,
1485
1614
  line1: String,
1486
1615
  line2: T.nilable(String),
1487
- state: String,
1488
- zip: String
1616
+ state: T.nilable(String),
1617
+ zip: T.nilable(String)
1489
1618
  ).returns(T.attached_class)
1490
1619
  end
1491
1620
  def self.new(
1492
- # The city of the address.
1621
+ # The city, district, town, or village of the address.
1493
1622
  city:,
1623
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1624
+ country:,
1494
1625
  # The first line of the address.
1495
1626
  line1:,
1496
1627
  # The second line of the address.
1497
1628
  line2:,
1498
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1499
- # the address.
1629
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1630
+ # state, province, or region of the address.
1500
1631
  state:,
1501
- # The ZIP code of the address.
1632
+ # The ZIP or postal code of the address.
1502
1633
  zip:
1503
1634
  )
1504
1635
  end
@@ -1506,11 +1637,12 @@ module Increase
1506
1637
  sig do
1507
1638
  override.returns(
1508
1639
  {
1509
- city: String,
1640
+ city: T.nilable(String),
1641
+ country: String,
1510
1642
  line1: String,
1511
1643
  line2: T.nilable(String),
1512
- state: String,
1513
- zip: String
1644
+ state: T.nilable(String),
1645
+ zip: T.nilable(String)
1514
1646
  }
1515
1647
  )
1516
1648
  end
@@ -2021,10 +2153,14 @@ module Increase
2021
2153
  )
2022
2154
  end
2023
2155
 
2024
- # The city of the address.
2025
- sig { returns(String) }
2156
+ # The city, district, town, or village of the address.
2157
+ sig { returns(T.nilable(String)) }
2026
2158
  attr_accessor :city
2027
2159
 
2160
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2161
+ sig { returns(String) }
2162
+ attr_accessor :country
2163
+
2028
2164
  # The first line of the address.
2029
2165
  sig { returns(String) }
2030
2166
  attr_accessor :line1
@@ -2033,36 +2169,39 @@ module Increase
2033
2169
  sig { returns(T.nilable(String)) }
2034
2170
  attr_accessor :line2
2035
2171
 
2036
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2037
- # the address.
2038
- sig { returns(String) }
2172
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2173
+ # state, province, or region of the address.
2174
+ sig { returns(T.nilable(String)) }
2039
2175
  attr_accessor :state
2040
2176
 
2041
- # The ZIP code of the address.
2042
- sig { returns(String) }
2177
+ # The ZIP or postal code of the address.
2178
+ sig { returns(T.nilable(String)) }
2043
2179
  attr_accessor :zip
2044
2180
 
2045
2181
  # The trust's address.
2046
2182
  sig do
2047
2183
  params(
2048
- city: String,
2184
+ city: T.nilable(String),
2185
+ country: String,
2049
2186
  line1: String,
2050
2187
  line2: T.nilable(String),
2051
- state: String,
2052
- zip: String
2188
+ state: T.nilable(String),
2189
+ zip: T.nilable(String)
2053
2190
  ).returns(T.attached_class)
2054
2191
  end
2055
2192
  def self.new(
2056
- # The city of the address.
2193
+ # The city, district, town, or village of the address.
2057
2194
  city:,
2195
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2196
+ country:,
2058
2197
  # The first line of the address.
2059
2198
  line1:,
2060
2199
  # The second line of the address.
2061
2200
  line2:,
2062
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2063
- # the address.
2201
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2202
+ # state, province, or region of the address.
2064
2203
  state:,
2065
- # The ZIP code of the address.
2204
+ # The ZIP or postal code of the address.
2066
2205
  zip:
2067
2206
  )
2068
2207
  end
@@ -2070,11 +2209,12 @@ module Increase
2070
2209
  sig do
2071
2210
  override.returns(
2072
2211
  {
2073
- city: String,
2212
+ city: T.nilable(String),
2213
+ country: String,
2074
2214
  line1: String,
2075
2215
  line2: T.nilable(String),
2076
- state: String,
2077
- zip: String
2216
+ state: T.nilable(String),
2217
+ zip: T.nilable(String)
2078
2218
  }
2079
2219
  )
2080
2220
  end
@@ -2192,10 +2332,14 @@ module Increase
2192
2332
  )
2193
2333
  end
2194
2334
 
2195
- # The city of the address.
2196
- sig { returns(String) }
2335
+ # The city, district, town, or village of the address.
2336
+ sig { returns(T.nilable(String)) }
2197
2337
  attr_accessor :city
2198
2338
 
2339
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2340
+ sig { returns(String) }
2341
+ attr_accessor :country
2342
+
2199
2343
  # The first line of the address.
2200
2344
  sig { returns(String) }
2201
2345
  attr_accessor :line1
@@ -2204,36 +2348,39 @@ module Increase
2204
2348
  sig { returns(T.nilable(String)) }
2205
2349
  attr_accessor :line2
2206
2350
 
2207
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2208
- # the address.
2209
- sig { returns(String) }
2351
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2352
+ # state, province, or region of the address.
2353
+ sig { returns(T.nilable(String)) }
2210
2354
  attr_accessor :state
2211
2355
 
2212
- # The ZIP code of the address.
2213
- sig { returns(String) }
2356
+ # The ZIP or postal code of the address.
2357
+ sig { returns(T.nilable(String)) }
2214
2358
  attr_accessor :zip
2215
2359
 
2216
2360
  # The person's address.
2217
2361
  sig do
2218
2362
  params(
2219
- city: String,
2363
+ city: T.nilable(String),
2364
+ country: String,
2220
2365
  line1: String,
2221
2366
  line2: T.nilable(String),
2222
- state: String,
2223
- zip: String
2367
+ state: T.nilable(String),
2368
+ zip: T.nilable(String)
2224
2369
  ).returns(T.attached_class)
2225
2370
  end
2226
2371
  def self.new(
2227
- # The city of the address.
2372
+ # The city, district, town, or village of the address.
2228
2373
  city:,
2374
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2375
+ country:,
2229
2376
  # The first line of the address.
2230
2377
  line1:,
2231
2378
  # The second line of the address.
2232
2379
  line2:,
2233
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2234
- # the address.
2380
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2381
+ # state, province, or region of the address.
2235
2382
  state:,
2236
- # The ZIP code of the address.
2383
+ # The ZIP or postal code of the address.
2237
2384
  zip:
2238
2385
  )
2239
2386
  end
@@ -2241,11 +2388,12 @@ module Increase
2241
2388
  sig do
2242
2389
  override.returns(
2243
2390
  {
2244
- city: String,
2391
+ city: T.nilable(String),
2392
+ country: String,
2245
2393
  line1: String,
2246
2394
  line2: T.nilable(String),
2247
- state: String,
2248
- zip: String
2395
+ state: T.nilable(String),
2396
+ zip: T.nilable(String)
2249
2397
  }
2250
2398
  )
2251
2399
  end
@@ -2519,10 +2667,14 @@ module Increase
2519
2667
  )
2520
2668
  end
2521
2669
 
2522
- # The city of the address.
2523
- sig { returns(String) }
2670
+ # The city, district, town, or village of the address.
2671
+ sig { returns(T.nilable(String)) }
2524
2672
  attr_accessor :city
2525
2673
 
2674
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2675
+ sig { returns(String) }
2676
+ attr_accessor :country
2677
+
2526
2678
  # The first line of the address.
2527
2679
  sig { returns(String) }
2528
2680
  attr_accessor :line1
@@ -2531,36 +2683,39 @@ module Increase
2531
2683
  sig { returns(T.nilable(String)) }
2532
2684
  attr_accessor :line2
2533
2685
 
2534
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2535
- # the address.
2536
- sig { returns(String) }
2686
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2687
+ # state, province, or region of the address.
2688
+ sig { returns(T.nilable(String)) }
2537
2689
  attr_accessor :state
2538
2690
 
2539
- # The ZIP code of the address.
2540
- sig { returns(String) }
2691
+ # The ZIP or postal code of the address.
2692
+ sig { returns(T.nilable(String)) }
2541
2693
  attr_accessor :zip
2542
2694
 
2543
2695
  # The person's address.
2544
2696
  sig do
2545
2697
  params(
2546
- city: String,
2698
+ city: T.nilable(String),
2699
+ country: String,
2547
2700
  line1: String,
2548
2701
  line2: T.nilable(String),
2549
- state: String,
2550
- zip: String
2702
+ state: T.nilable(String),
2703
+ zip: T.nilable(String)
2551
2704
  ).returns(T.attached_class)
2552
2705
  end
2553
2706
  def self.new(
2554
- # The city of the address.
2707
+ # The city, district, town, or village of the address.
2555
2708
  city:,
2709
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2710
+ country:,
2556
2711
  # The first line of the address.
2557
2712
  line1:,
2558
2713
  # The second line of the address.
2559
2714
  line2:,
2560
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2561
- # the address.
2715
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2716
+ # state, province, or region of the address.
2562
2717
  state:,
2563
- # The ZIP code of the address.
2718
+ # The ZIP or postal code of the address.
2564
2719
  zip:
2565
2720
  )
2566
2721
  end
@@ -2568,11 +2723,12 @@ module Increase
2568
2723
  sig do
2569
2724
  override.returns(
2570
2725
  {
2571
- city: String,
2726
+ city: T.nilable(String),
2727
+ country: String,
2572
2728
  line1: String,
2573
2729
  line2: T.nilable(String),
2574
- state: String,
2575
- zip: String
2730
+ state: T.nilable(String),
2731
+ zip: T.nilable(String)
2576
2732
  }
2577
2733
  )
2578
2734
  end