increase 0.502.0 → 0.504.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 (12) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/package.json +1 -1
  3. package/resources/entities.d.mts +187 -110
  4. package/resources/entities.d.mts.map +1 -1
  5. package/resources/entities.d.ts +187 -110
  6. package/resources/entities.d.ts.map +1 -1
  7. package/src/resources/entities.ts +204 -110
  8. package/src/version.ts +1 -1
  9. package/version.d.mts +1 -1
  10. package/version.d.ts +1 -1
  11. package/version.js +1 -1
  12. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.504.0 (2026-03-27)
4
+
5
+ Full Changelog: [v0.503.0...v0.504.0](https://github.com/Increase/increase-typescript/compare/v0.503.0...v0.504.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([5037d97](https://github.com/Increase/increase-typescript/commit/5037d97f0ebb7c9797fc31989ede4dc8066337af))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** update multipart form array serialization ([73130be](https://github.com/Increase/increase-typescript/commit/73130be66c51017b50d0cdd233dc5dc95ffb9bbc))
15
+
16
+ ## 0.503.0 (2026-03-25)
17
+
18
+ Full Changelog: [v0.502.0...v0.503.0](https://github.com/Increase/increase-typescript/compare/v0.502.0...v0.503.0)
19
+
20
+ ### Features
21
+
22
+ * **api:** api update ([2454fca](https://github.com/Increase/increase-typescript/commit/2454fcae2622e5f0a7ae50c6778eec25ae162ef1))
23
+
3
24
  ## 0.502.0 (2026-03-25)
4
25
 
5
26
  Full Changelog: [v0.501.0...v0.502.0](https://github.com/Increase/increase-typescript/compare/v0.501.0...v0.502.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "increase",
3
- "version": "0.502.0",
3
+ "version": "0.504.0",
4
4
  "description": "The official TypeScript library for the Increase API",
5
5
  "author": "Increase <dev-feedback@increase.com>",
6
6
  "types": "./index.d.ts",
package/resources/entities.d.mts CHANGED
@@ -218,9 +218,13 @@ export declare namespace Entity {
218
218
  */
219
219
  interface Address {
220
220
  /**
221
- * The city of the address.
221
+ * The city, district, town, or village of the address.
222
222
  */
223
- city: string;
223
+ city: string | null;
224
+ /**
225
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
226
+ */
227
+ country: string;
224
228
  /**
225
229
  * The first line of the address.
226
230
  */
@@ -230,14 +234,14 @@ export declare namespace Entity {
230
234
  */
231
235
  line2: string | null;
232
236
  /**
233
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
234
- * the address.
237
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
238
+ * state, province, or region of the address.
235
239
  */
236
- state: string;
240
+ state: string | null;
237
241
  /**
238
- * The ZIP code of the address.
242
+ * The ZIP or postal code of the address.
239
243
  */
240
- zip: string;
244
+ zip: string | null;
241
245
  }
242
246
  interface BeneficialOwner {
243
247
  /**
@@ -395,9 +399,13 @@ export declare namespace Entity {
395
399
  */
396
400
  interface Address {
397
401
  /**
398
- * The city of the address.
402
+ * The city, district, town, or village of the address.
399
403
  */
400
- city: string;
404
+ city: string | null;
405
+ /**
406
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
407
+ */
408
+ country: string;
401
409
  /**
402
410
  * The first line of the address.
403
411
  */
@@ -407,14 +415,14 @@ export declare namespace Entity {
407
415
  */
408
416
  line2: string | null;
409
417
  /**
410
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
411
- * the address.
418
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
419
+ * state, province, or region of the address.
412
420
  */
413
- state: string;
421
+ state: string | null;
414
422
  /**
415
- * The ZIP code of the address.
423
+ * The ZIP or postal code of the address.
416
424
  */
417
- zip: string;
425
+ zip: string | null;
418
426
  }
419
427
  interface AuthorizedPerson {
420
428
  /**
@@ -465,9 +473,13 @@ export declare namespace Entity {
465
473
  */
466
474
  interface Address {
467
475
  /**
468
- * The city of the address.
476
+ * The city, district, town, or village of the address.
469
477
  */
470
- city: string;
478
+ city: string | null;
479
+ /**
480
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
481
+ */
482
+ country: string;
471
483
  /**
472
484
  * The first line of the address.
473
485
  */
@@ -477,14 +489,14 @@ export declare namespace Entity {
477
489
  */
478
490
  line2: string | null;
479
491
  /**
480
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
481
- * the address.
492
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
493
+ * state, province, or region of the address.
482
494
  */
483
- state: string;
495
+ state: string | null;
484
496
  /**
485
- * The ZIP code of the address.
497
+ * The ZIP or postal code of the address.
486
498
  */
487
- zip: string;
499
+ zip: string | null;
488
500
  }
489
501
  /**
490
502
  * A means of verifying the person's identity.
@@ -538,9 +550,13 @@ export declare namespace Entity {
538
550
  */
539
551
  interface Address {
540
552
  /**
541
- * The city of the address.
553
+ * The city, district, town, or village of the address.
542
554
  */
543
- city: string;
555
+ city: string | null;
556
+ /**
557
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
558
+ */
559
+ country: string;
544
560
  /**
545
561
  * The first line of the address.
546
562
  */
@@ -550,14 +566,14 @@ export declare namespace Entity {
550
566
  */
551
567
  line2: string | null;
552
568
  /**
553
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
554
- * the address.
569
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
570
+ * state, province, or region of the address.
555
571
  */
556
- state: string;
572
+ state: string | null;
557
573
  /**
558
- * The ZIP code of the address.
574
+ * The ZIP or postal code of the address.
559
575
  */
560
- zip: string;
576
+ zip: string | null;
561
577
  }
562
578
  /**
563
579
  * A means of verifying the person's identity.
@@ -683,9 +699,13 @@ export declare namespace Entity {
683
699
  */
684
700
  interface Address {
685
701
  /**
686
- * The city of the address.
702
+ * The city, district, town, or village of the address.
687
703
  */
688
- city: string;
704
+ city: string | null;
705
+ /**
706
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
707
+ */
708
+ country: string;
689
709
  /**
690
710
  * The first line of the address.
691
711
  */
@@ -695,14 +715,14 @@ export declare namespace Entity {
695
715
  */
696
716
  line2: string | null;
697
717
  /**
698
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
699
- * the address.
718
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
719
+ * state, province, or region of the address.
700
720
  */
701
- state: string;
721
+ state: string | null;
702
722
  /**
703
- * The ZIP code of the address.
723
+ * The ZIP or postal code of the address.
704
724
  */
705
- zip: string;
725
+ zip: string | null;
706
726
  }
707
727
  /**
708
728
  * The grantor of the trust. Will be present if the `category` is `revocable`.
@@ -731,9 +751,13 @@ export declare namespace Entity {
731
751
  */
732
752
  interface Address {
733
753
  /**
734
- * The city of the address.
754
+ * The city, district, town, or village of the address.
735
755
  */
736
- city: string;
756
+ city: string | null;
757
+ /**
758
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
759
+ */
760
+ country: string;
737
761
  /**
738
762
  * The first line of the address.
739
763
  */
@@ -743,14 +767,14 @@ export declare namespace Entity {
743
767
  */
744
768
  line2: string | null;
745
769
  /**
746
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
747
- * the address.
770
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
771
+ * state, province, or region of the address.
748
772
  */
749
- state: string;
773
+ state: string | null;
750
774
  /**
751
- * The ZIP code of the address.
775
+ * The ZIP or postal code of the address.
752
776
  */
753
- zip: string;
777
+ zip: string | null;
754
778
  }
755
779
  /**
756
780
  * A means of verifying the person's identity.
@@ -817,9 +841,13 @@ export declare namespace Entity {
817
841
  */
818
842
  interface Address {
819
843
  /**
820
- * The city of the address.
844
+ * The city, district, town, or village of the address.
821
845
  */
822
- city: string;
846
+ city: string | null;
847
+ /**
848
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
849
+ */
850
+ country: string;
823
851
  /**
824
852
  * The first line of the address.
825
853
  */
@@ -829,14 +857,14 @@ export declare namespace Entity {
829
857
  */
830
858
  line2: string | null;
831
859
  /**
832
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
833
- * the address.
860
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
861
+ * state, province, or region of the address.
834
862
  */
835
- state: string;
863
+ state: string | null;
836
864
  /**
837
- * The ZIP code of the address.
865
+ * The ZIP or postal code of the address.
838
866
  */
839
- zip: string;
867
+ zip: string | null;
840
868
  }
841
869
  /**
842
870
  * A means of verifying the person's identity.
@@ -898,7 +926,7 @@ export declare namespace Entity {
898
926
  *
899
927
  * - `entity_tax_identifier` - The entity's tax identifier could not be validated.
900
928
  * Update the tax ID with the
901
- * [update an entity API](/documentation/api/entities#update-an-entity.corporation.tax_identifier).
929
+ * [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
902
930
  * - `entity_address` - The entity's address could not be validated. Update the
903
931
  * address with the
904
932
  * [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
@@ -1097,26 +1125,30 @@ export declare namespace EntityCreateParams {
1097
1125
  */
1098
1126
  interface Address {
1099
1127
  /**
1100
- * The city of the address.
1128
+ * The city, district, town, or village of the address.
1101
1129
  */
1102
1130
  city: string;
1131
+ /**
1132
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1133
+ */
1134
+ country: string;
1103
1135
  /**
1104
1136
  * The first line of the address. This is usually the street number and street.
1105
1137
  */
1106
1138
  line1: string;
1107
1139
  /**
1108
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1109
- * the address.
1140
+ * The second line of the address. This might be the floor or room number.
1110
1141
  */
1111
- state: string;
1142
+ line2?: string;
1112
1143
  /**
1113
- * The ZIP code of the address.
1144
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
1145
+ * state, province, or region of the address. Required in certain countries.
1114
1146
  */
1115
- zip: string;
1147
+ state?: string;
1116
1148
  /**
1117
- * The second line of the address. This might be the floor or room number.
1149
+ * The ZIP or postal code of the address. Required in certain countries.
1118
1150
  */
1119
- line2?: string;
1151
+ zip?: string;
1120
1152
  }
1121
1153
  interface BeneficialOwner {
1122
1154
  /**
@@ -1443,26 +1475,30 @@ export declare namespace EntityCreateParams {
1443
1475
  */
1444
1476
  interface Address {
1445
1477
  /**
1446
- * The city of the address.
1478
+ * The city, district, town, or village of the address.
1447
1479
  */
1448
1480
  city: string;
1481
+ /**
1482
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1483
+ */
1484
+ country: string;
1449
1485
  /**
1450
1486
  * The first line of the address. This is usually the street number and street.
1451
1487
  */
1452
1488
  line1: string;
1453
1489
  /**
1454
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1455
- * the address.
1490
+ * The second line of the address. This might be the floor or room number.
1456
1491
  */
1457
- state: string;
1492
+ line2?: string;
1458
1493
  /**
1459
- * The ZIP code of the address.
1494
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
1495
+ * state, province, or region of the address. Required in certain countries.
1460
1496
  */
1461
- zip: string;
1497
+ state?: string;
1462
1498
  /**
1463
- * The second line of the address. This might be the floor or room number.
1499
+ * The ZIP or postal code of the address. Required in certain countries.
1464
1500
  */
1465
- line2?: string;
1501
+ zip?: string;
1466
1502
  }
1467
1503
  /**
1468
1504
  * A means of verifying the person's identity.
@@ -1613,26 +1649,30 @@ export declare namespace EntityCreateParams {
1613
1649
  */
1614
1650
  interface Address {
1615
1651
  /**
1616
- * The city of the address.
1652
+ * The city, district, town, or village of the address.
1617
1653
  */
1618
1654
  city: string;
1655
+ /**
1656
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1657
+ */
1658
+ country: string;
1619
1659
  /**
1620
1660
  * The first line of the address. This is usually the street number and street.
1621
1661
  */
1622
1662
  line1: string;
1623
1663
  /**
1624
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1625
- * the address.
1664
+ * The second line of the address. This might be the floor or room number.
1626
1665
  */
1627
- state: string;
1666
+ line2?: string;
1628
1667
  /**
1629
- * The ZIP code of the address.
1668
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
1669
+ * state, province, or region of the address. Required in certain countries.
1630
1670
  */
1631
- zip: string;
1671
+ state?: string;
1632
1672
  /**
1633
- * The second line of the address. This might be the floor or room number.
1673
+ * The ZIP or postal code of the address. Required in certain countries.
1634
1674
  */
1635
- line2?: string;
1675
+ zip?: string;
1636
1676
  }
1637
1677
  /**
1638
1678
  * A means of verifying the person's identity.
@@ -1928,26 +1968,30 @@ export declare namespace EntityCreateParams {
1928
1968
  */
1929
1969
  interface Address {
1930
1970
  /**
1931
- * The city of the address.
1971
+ * The city, district, town, or village of the address.
1932
1972
  */
1933
1973
  city: string;
1974
+ /**
1975
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1976
+ */
1977
+ country: string;
1934
1978
  /**
1935
1979
  * The first line of the address. This is usually the street number and street.
1936
1980
  */
1937
1981
  line1: string;
1938
1982
  /**
1939
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
1940
- * the address.
1983
+ * The second line of the address. This might be the floor or room number.
1941
1984
  */
1942
- state: string;
1985
+ line2?: string;
1943
1986
  /**
1944
- * The ZIP code of the address.
1987
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
1988
+ * state, province, or region of the address. Required in certain countries.
1945
1989
  */
1946
- zip: string;
1990
+ state?: string;
1947
1991
  /**
1948
- * The second line of the address. This might be the floor or room number.
1992
+ * The ZIP or postal code of the address. Required in certain countries.
1949
1993
  */
1950
- line2?: string;
1994
+ zip?: string;
1951
1995
  }
1952
1996
  /**
1953
1997
  * A means of verifying the person's identity.
@@ -2095,26 +2139,30 @@ export declare namespace EntityCreateParams {
2095
2139
  */
2096
2140
  interface Address {
2097
2141
  /**
2098
- * The city of the address.
2142
+ * The city, district, town, or village of the address.
2099
2143
  */
2100
2144
  city: string;
2145
+ /**
2146
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2147
+ */
2148
+ country: string;
2101
2149
  /**
2102
2150
  * The first line of the address. This is usually the street number and street.
2103
2151
  */
2104
2152
  line1: string;
2105
2153
  /**
2106
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
2107
- * the address.
2154
+ * The second line of the address. This might be the floor or room number.
2108
2155
  */
2109
- state: string;
2156
+ line2?: string;
2110
2157
  /**
2111
- * The ZIP code of the address.
2158
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
2159
+ * state, province, or region of the address. Required in certain countries.
2112
2160
  */
2113
- zip: string;
2161
+ state?: string;
2114
2162
  /**
2115
- * The second line of the address. This might be the floor or room number.
2163
+ * The ZIP or postal code of the address. Required in certain countries.
2116
2164
  */
2117
- line2?: string;
2165
+ zip?: string;
2118
2166
  }
2119
2167
  /**
2120
2168
  * A means of verifying the person's identity.
@@ -2295,13 +2343,15 @@ export declare namespace EntityUpdateParams {
2295
2343
  */
2296
2344
  industry_code?: string;
2297
2345
  /**
2298
- * The legal name of the corporation.
2346
+ * The legal identifier of the corporation. This is usually the Employer
2347
+ * Identification Number (EIN).
2299
2348
  */
2300
- name?: string;
2349
+ legal_identifier?: Corporation.LegalIdentifier;
2301
2350
  /**
2302
- * The Employer Identification Number (EIN) for the corporation.
2351
+ * The legal name of the corporation.
2303
2352
  */
2304
- tax_identifier?: string;
2353
+ name?: string;
2354
+ [k: string]: unknown;
2305
2355
  }
2306
2356
  namespace Corporation {
2307
2357
  /**
@@ -2310,26 +2360,49 @@ export declare namespace EntityUpdateParams {
2310
2360
  */
2311
2361
  interface Address {
2312
2362
  /**
2313
- * The city of the address.
2363
+ * The city, district, town, or village of the address.
2314
2364
  */
2315
2365
  city: string;
2366
+ /**
2367
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2368
+ */
2369
+ country: string;
2316
2370
  /**
2317
2371
  * The first line of the address. This is usually the street number and street.
2318
2372
  */
2319
2373
  line1: string;
2320
2374
  /**
2321
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
2322
- * the address.
2375
+ * The second line of the address. This might be the floor or room number.
2323
2376
  */
2324
- state: string;
2377
+ line2?: string;
2325
2378
  /**
2326
- * The ZIP code of the address.
2379
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
2380
+ * state, province, or region of the address. Required in certain countries.
2327
2381
  */
2328
- zip: string;
2382
+ state?: string;
2329
2383
  /**
2330
- * The second line of the address. This might be the floor or room number.
2384
+ * The ZIP or postal code of the address. Required in certain countries.
2331
2385
  */
2332
- line2?: string;
2386
+ zip?: string;
2387
+ }
2388
+ /**
2389
+ * The legal identifier of the corporation. This is usually the Employer
2390
+ * Identification Number (EIN).
2391
+ */
2392
+ interface LegalIdentifier {
2393
+ /**
2394
+ * The identifier of the legal identifier.
2395
+ */
2396
+ value: string;
2397
+ /**
2398
+ * The category of the legal identifier.
2399
+ *
2400
+ * - `us_employer_identification_number` - The Employer Identification Number (EIN)
2401
+ * for the company. The EIN is a 9-digit number assigned by the IRS.
2402
+ * - `other` - A legal identifier issued by a foreign government, like a tax
2403
+ * identification number or registration number.
2404
+ */
2405
+ category?: 'us_employer_identification_number' | 'other';
2333
2406
  }
2334
2407
  }
2335
2408
  /**
@@ -2398,26 +2471,30 @@ export declare namespace EntityUpdateParams {
2398
2471
  */
2399
2472
  interface Address {
2400
2473
  /**
2401
- * The city of the address.
2474
+ * The city, district, town, or village of the address.
2402
2475
  */
2403
2476
  city: string;
2477
+ /**
2478
+ * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2479
+ */
2480
+ country: string;
2404
2481
  /**
2405
2482
  * The first line of the address. This is usually the street number and street.
2406
2483
  */
2407
2484
  line1: string;
2408
2485
  /**
2409
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
2410
- * the address.
2486
+ * The second line of the address. This might be the floor or room number.
2411
2487
  */
2412
- state: string;
2488
+ line2?: string;
2413
2489
  /**
2414
- * The ZIP code of the address.
2490
+ * The two-letter United States Postal Service (USPS) abbreviation for the US
2491
+ * state, province, or region of the address. Required in certain countries.
2415
2492
  */
2416
- zip: string;
2493
+ state?: string;
2417
2494
  /**
2418
- * The second line of the address. This might be the floor or room number.
2495
+ * The ZIP or postal code of the address. Required in certain countries.
2419
2496
  */
2420
- line2?: string;
2497
+ zip?: string;
2421
2498
  }
2422
2499
  }
2423
2500
  /**