increase 1.271.0 → 1.274.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.
@@ -379,10 +379,14 @@ module Increase
379
379
  )
380
380
  end
381
381
 
382
- # The city of the address.
383
- sig { returns(String) }
382
+ # The city, district, town, or village of the address.
383
+ sig { returns(T.nilable(String)) }
384
384
  attr_accessor :city
385
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
+
386
390
  # The first line of the address.
387
391
  sig { returns(String) }
388
392
  attr_accessor :line1
@@ -391,36 +395,39 @@ module Increase
391
395
  sig { returns(T.nilable(String)) }
392
396
  attr_accessor :line2
393
397
 
394
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
395
- # the address.
396
- 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)) }
397
401
  attr_accessor :state
398
402
 
399
- # The ZIP code of the address.
400
- sig { returns(String) }
403
+ # The ZIP or postal code of the address.
404
+ sig { returns(T.nilable(String)) }
401
405
  attr_accessor :zip
402
406
 
403
407
  # The corporation's address.
404
408
  sig do
405
409
  params(
406
- city: String,
410
+ city: T.nilable(String),
411
+ country: String,
407
412
  line1: String,
408
413
  line2: T.nilable(String),
409
- state: String,
410
- zip: String
414
+ state: T.nilable(String),
415
+ zip: T.nilable(String)
411
416
  ).returns(T.attached_class)
412
417
  end
413
418
  def self.new(
414
- # The city of the address.
419
+ # The city, district, town, or village of the address.
415
420
  city:,
421
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
422
+ country:,
416
423
  # The first line of the address.
417
424
  line1:,
418
425
  # The second line of the address.
419
426
  line2:,
420
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
421
- # the address.
427
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
428
+ # state, province, or region of the address.
422
429
  state:,
423
- # The ZIP code of the address.
430
+ # The ZIP or postal code of the address.
424
431
  zip:
425
432
  )
426
433
  end
@@ -428,11 +435,12 @@ module Increase
428
435
  sig do
429
436
  override.returns(
430
437
  {
431
- city: String,
438
+ city: T.nilable(String),
439
+ country: String,
432
440
  line1: String,
433
441
  line2: T.nilable(String),
434
- state: String,
435
- zip: String
442
+ state: T.nilable(String),
443
+ zip: T.nilable(String)
436
444
  }
437
445
  )
438
446
  end
@@ -1031,10 +1039,14 @@ module Increase
1031
1039
  )
1032
1040
  end
1033
1041
 
1034
- # The city of the address.
1035
- sig { returns(String) }
1042
+ # The city, district, town, or village of the address.
1043
+ sig { returns(T.nilable(String)) }
1036
1044
  attr_accessor :city
1037
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
+
1038
1050
  # The first line of the address.
1039
1051
  sig { returns(String) }
1040
1052
  attr_accessor :line1
@@ -1043,36 +1055,39 @@ module Increase
1043
1055
  sig { returns(T.nilable(String)) }
1044
1056
  attr_accessor :line2
1045
1057
 
1046
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1047
- # the address.
1048
- 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)) }
1049
1061
  attr_accessor :state
1050
1062
 
1051
- # The ZIP code of the address.
1052
- sig { returns(String) }
1063
+ # The ZIP or postal code of the address.
1064
+ sig { returns(T.nilable(String)) }
1053
1065
  attr_accessor :zip
1054
1066
 
1055
1067
  # The government authority's address.
1056
1068
  sig do
1057
1069
  params(
1058
- city: String,
1070
+ city: T.nilable(String),
1071
+ country: String,
1059
1072
  line1: String,
1060
1073
  line2: T.nilable(String),
1061
- state: String,
1062
- zip: String
1074
+ state: T.nilable(String),
1075
+ zip: T.nilable(String)
1063
1076
  ).returns(T.attached_class)
1064
1077
  end
1065
1078
  def self.new(
1066
- # The city of the address.
1079
+ # The city, district, town, or village of the address.
1067
1080
  city:,
1081
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1082
+ country:,
1068
1083
  # The first line of the address.
1069
1084
  line1:,
1070
1085
  # The second line of the address.
1071
1086
  line2:,
1072
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1073
- # the address.
1087
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1088
+ # state, province, or region of the address.
1074
1089
  state:,
1075
- # The ZIP code of the address.
1090
+ # The ZIP or postal code of the address.
1076
1091
  zip:
1077
1092
  )
1078
1093
  end
@@ -1080,11 +1095,12 @@ module Increase
1080
1095
  sig do
1081
1096
  override.returns(
1082
1097
  {
1083
- city: String,
1098
+ city: T.nilable(String),
1099
+ country: String,
1084
1100
  line1: String,
1085
1101
  line2: T.nilable(String),
1086
- state: String,
1087
- zip: String
1102
+ state: T.nilable(String),
1103
+ zip: T.nilable(String)
1088
1104
  }
1089
1105
  )
1090
1106
  end
@@ -1303,10 +1319,14 @@ module Increase
1303
1319
  )
1304
1320
  end
1305
1321
 
1306
- # The city of the address.
1307
- sig { returns(String) }
1322
+ # The city, district, town, or village of the address.
1323
+ sig { returns(T.nilable(String)) }
1308
1324
  attr_accessor :city
1309
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
+
1310
1330
  # The first line of the address.
1311
1331
  sig { returns(String) }
1312
1332
  attr_accessor :line1
@@ -1315,36 +1335,39 @@ module Increase
1315
1335
  sig { returns(T.nilable(String)) }
1316
1336
  attr_accessor :line2
1317
1337
 
1318
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1319
- # the address.
1320
- 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)) }
1321
1341
  attr_accessor :state
1322
1342
 
1323
- # The ZIP code of the address.
1324
- sig { returns(String) }
1343
+ # The ZIP or postal code of the address.
1344
+ sig { returns(T.nilable(String)) }
1325
1345
  attr_accessor :zip
1326
1346
 
1327
1347
  # The person's address.
1328
1348
  sig do
1329
1349
  params(
1330
- city: String,
1350
+ city: T.nilable(String),
1351
+ country: String,
1331
1352
  line1: String,
1332
1353
  line2: T.nilable(String),
1333
- state: String,
1334
- zip: String
1354
+ state: T.nilable(String),
1355
+ zip: T.nilable(String)
1335
1356
  ).returns(T.attached_class)
1336
1357
  end
1337
1358
  def self.new(
1338
- # The city of the address.
1359
+ # The city, district, town, or village of the address.
1339
1360
  city:,
1361
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1362
+ country:,
1340
1363
  # The first line of the address.
1341
1364
  line1:,
1342
1365
  # The second line of the address.
1343
1366
  line2:,
1344
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1345
- # the address.
1367
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1368
+ # state, province, or region of the address.
1346
1369
  state:,
1347
- # The ZIP code of the address.
1370
+ # The ZIP or postal code of the address.
1348
1371
  zip:
1349
1372
  )
1350
1373
  end
@@ -1352,11 +1375,12 @@ module Increase
1352
1375
  sig do
1353
1376
  override.returns(
1354
1377
  {
1355
- city: String,
1378
+ city: T.nilable(String),
1379
+ country: String,
1356
1380
  line1: String,
1357
1381
  line2: T.nilable(String),
1358
- state: String,
1359
- zip: String
1382
+ state: T.nilable(String),
1383
+ zip: T.nilable(String)
1360
1384
  }
1361
1385
  )
1362
1386
  end
@@ -1557,10 +1581,14 @@ module Increase
1557
1581
  )
1558
1582
  end
1559
1583
 
1560
- # The city of the address.
1561
- sig { returns(String) }
1584
+ # The city, district, town, or village of the address.
1585
+ sig { returns(T.nilable(String)) }
1562
1586
  attr_accessor :city
1563
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
+
1564
1592
  # The first line of the address.
1565
1593
  sig { returns(String) }
1566
1594
  attr_accessor :line1
@@ -1569,36 +1597,39 @@ module Increase
1569
1597
  sig { returns(T.nilable(String)) }
1570
1598
  attr_accessor :line2
1571
1599
 
1572
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1573
- # the address.
1574
- 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)) }
1575
1603
  attr_accessor :state
1576
1604
 
1577
- # The ZIP code of the address.
1578
- sig { returns(String) }
1605
+ # The ZIP or postal code of the address.
1606
+ sig { returns(T.nilable(String)) }
1579
1607
  attr_accessor :zip
1580
1608
 
1581
1609
  # The person's address.
1582
1610
  sig do
1583
1611
  params(
1584
- city: String,
1612
+ city: T.nilable(String),
1613
+ country: String,
1585
1614
  line1: String,
1586
1615
  line2: T.nilable(String),
1587
- state: String,
1588
- zip: String
1616
+ state: T.nilable(String),
1617
+ zip: T.nilable(String)
1589
1618
  ).returns(T.attached_class)
1590
1619
  end
1591
1620
  def self.new(
1592
- # The city of the address.
1621
+ # The city, district, town, or village of the address.
1593
1622
  city:,
1623
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1624
+ country:,
1594
1625
  # The first line of the address.
1595
1626
  line1:,
1596
1627
  # The second line of the address.
1597
1628
  line2:,
1598
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
1599
- # the address.
1629
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1630
+ # state, province, or region of the address.
1600
1631
  state:,
1601
- # The ZIP code of the address.
1632
+ # The ZIP or postal code of the address.
1602
1633
  zip:
1603
1634
  )
1604
1635
  end
@@ -1606,11 +1637,12 @@ module Increase
1606
1637
  sig do
1607
1638
  override.returns(
1608
1639
  {
1609
- city: String,
1640
+ city: T.nilable(String),
1641
+ country: String,
1610
1642
  line1: String,
1611
1643
  line2: T.nilable(String),
1612
- state: String,
1613
- zip: String
1644
+ state: T.nilable(String),
1645
+ zip: T.nilable(String)
1614
1646
  }
1615
1647
  )
1616
1648
  end
@@ -2121,10 +2153,14 @@ module Increase
2121
2153
  )
2122
2154
  end
2123
2155
 
2124
- # The city of the address.
2125
- sig { returns(String) }
2156
+ # The city, district, town, or village of the address.
2157
+ sig { returns(T.nilable(String)) }
2126
2158
  attr_accessor :city
2127
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
+
2128
2164
  # The first line of the address.
2129
2165
  sig { returns(String) }
2130
2166
  attr_accessor :line1
@@ -2133,36 +2169,39 @@ module Increase
2133
2169
  sig { returns(T.nilable(String)) }
2134
2170
  attr_accessor :line2
2135
2171
 
2136
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2137
- # the address.
2138
- 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)) }
2139
2175
  attr_accessor :state
2140
2176
 
2141
- # The ZIP code of the address.
2142
- sig { returns(String) }
2177
+ # The ZIP or postal code of the address.
2178
+ sig { returns(T.nilable(String)) }
2143
2179
  attr_accessor :zip
2144
2180
 
2145
2181
  # The trust's address.
2146
2182
  sig do
2147
2183
  params(
2148
- city: String,
2184
+ city: T.nilable(String),
2185
+ country: String,
2149
2186
  line1: String,
2150
2187
  line2: T.nilable(String),
2151
- state: String,
2152
- zip: String
2188
+ state: T.nilable(String),
2189
+ zip: T.nilable(String)
2153
2190
  ).returns(T.attached_class)
2154
2191
  end
2155
2192
  def self.new(
2156
- # The city of the address.
2193
+ # The city, district, town, or village of the address.
2157
2194
  city:,
2195
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2196
+ country:,
2158
2197
  # The first line of the address.
2159
2198
  line1:,
2160
2199
  # The second line of the address.
2161
2200
  line2:,
2162
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2163
- # the address.
2201
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2202
+ # state, province, or region of the address.
2164
2203
  state:,
2165
- # The ZIP code of the address.
2204
+ # The ZIP or postal code of the address.
2166
2205
  zip:
2167
2206
  )
2168
2207
  end
@@ -2170,11 +2209,12 @@ module Increase
2170
2209
  sig do
2171
2210
  override.returns(
2172
2211
  {
2173
- city: String,
2212
+ city: T.nilable(String),
2213
+ country: String,
2174
2214
  line1: String,
2175
2215
  line2: T.nilable(String),
2176
- state: String,
2177
- zip: String
2216
+ state: T.nilable(String),
2217
+ zip: T.nilable(String)
2178
2218
  }
2179
2219
  )
2180
2220
  end
@@ -2292,10 +2332,14 @@ module Increase
2292
2332
  )
2293
2333
  end
2294
2334
 
2295
- # The city of the address.
2296
- sig { returns(String) }
2335
+ # The city, district, town, or village of the address.
2336
+ sig { returns(T.nilable(String)) }
2297
2337
  attr_accessor :city
2298
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
+
2299
2343
  # The first line of the address.
2300
2344
  sig { returns(String) }
2301
2345
  attr_accessor :line1
@@ -2304,36 +2348,39 @@ module Increase
2304
2348
  sig { returns(T.nilable(String)) }
2305
2349
  attr_accessor :line2
2306
2350
 
2307
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2308
- # the address.
2309
- 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)) }
2310
2354
  attr_accessor :state
2311
2355
 
2312
- # The ZIP code of the address.
2313
- sig { returns(String) }
2356
+ # The ZIP or postal code of the address.
2357
+ sig { returns(T.nilable(String)) }
2314
2358
  attr_accessor :zip
2315
2359
 
2316
2360
  # The person's address.
2317
2361
  sig do
2318
2362
  params(
2319
- city: String,
2363
+ city: T.nilable(String),
2364
+ country: String,
2320
2365
  line1: String,
2321
2366
  line2: T.nilable(String),
2322
- state: String,
2323
- zip: String
2367
+ state: T.nilable(String),
2368
+ zip: T.nilable(String)
2324
2369
  ).returns(T.attached_class)
2325
2370
  end
2326
2371
  def self.new(
2327
- # The city of the address.
2372
+ # The city, district, town, or village of the address.
2328
2373
  city:,
2374
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2375
+ country:,
2329
2376
  # The first line of the address.
2330
2377
  line1:,
2331
2378
  # The second line of the address.
2332
2379
  line2:,
2333
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2334
- # the address.
2380
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2381
+ # state, province, or region of the address.
2335
2382
  state:,
2336
- # The ZIP code of the address.
2383
+ # The ZIP or postal code of the address.
2337
2384
  zip:
2338
2385
  )
2339
2386
  end
@@ -2341,11 +2388,12 @@ module Increase
2341
2388
  sig do
2342
2389
  override.returns(
2343
2390
  {
2344
- city: String,
2391
+ city: T.nilable(String),
2392
+ country: String,
2345
2393
  line1: String,
2346
2394
  line2: T.nilable(String),
2347
- state: String,
2348
- zip: String
2395
+ state: T.nilable(String),
2396
+ zip: T.nilable(String)
2349
2397
  }
2350
2398
  )
2351
2399
  end
@@ -2619,10 +2667,14 @@ module Increase
2619
2667
  )
2620
2668
  end
2621
2669
 
2622
- # The city of the address.
2623
- sig { returns(String) }
2670
+ # The city, district, town, or village of the address.
2671
+ sig { returns(T.nilable(String)) }
2624
2672
  attr_accessor :city
2625
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
+
2626
2678
  # The first line of the address.
2627
2679
  sig { returns(String) }
2628
2680
  attr_accessor :line1
@@ -2631,36 +2683,39 @@ module Increase
2631
2683
  sig { returns(T.nilable(String)) }
2632
2684
  attr_accessor :line2
2633
2685
 
2634
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2635
- # the address.
2636
- 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)) }
2637
2689
  attr_accessor :state
2638
2690
 
2639
- # The ZIP code of the address.
2640
- sig { returns(String) }
2691
+ # The ZIP or postal code of the address.
2692
+ sig { returns(T.nilable(String)) }
2641
2693
  attr_accessor :zip
2642
2694
 
2643
2695
  # The person's address.
2644
2696
  sig do
2645
2697
  params(
2646
- city: String,
2698
+ city: T.nilable(String),
2699
+ country: String,
2647
2700
  line1: String,
2648
2701
  line2: T.nilable(String),
2649
- state: String,
2650
- zip: String
2702
+ state: T.nilable(String),
2703
+ zip: T.nilable(String)
2651
2704
  ).returns(T.attached_class)
2652
2705
  end
2653
2706
  def self.new(
2654
- # The city of the address.
2707
+ # The city, district, town, or village of the address.
2655
2708
  city:,
2709
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2710
+ country:,
2656
2711
  # The first line of the address.
2657
2712
  line1:,
2658
2713
  # The second line of the address.
2659
2714
  line2:,
2660
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2661
- # the address.
2715
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2716
+ # state, province, or region of the address.
2662
2717
  state:,
2663
- # The ZIP code of the address.
2718
+ # The ZIP or postal code of the address.
2664
2719
  zip:
2665
2720
  )
2666
2721
  end
@@ -2668,11 +2723,12 @@ module Increase
2668
2723
  sig do
2669
2724
  override.returns(
2670
2725
  {
2671
- city: String,
2726
+ city: T.nilable(String),
2727
+ country: String,
2672
2728
  line1: String,
2673
2729
  line2: T.nilable(String),
2674
- state: String,
2675
- zip: String
2730
+ state: T.nilable(String),
2731
+ zip: T.nilable(String)
2676
2732
  }
2677
2733
  )
2678
2734
  end
@@ -3155,7 +3211,7 @@ module Increase
3155
3211
  end
3156
3212
  OrSymbol = T.type_alias { T.any(Symbol, String) }
3157
3213
 
3158
- # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.tax_identifier).
3214
+ # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
3159
3215
  ENTITY_TAX_IDENTIFIER =
3160
3216
  T.let(
3161
3217
  :entity_tax_identifier,