increase 0.42.0 → 0.44.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 (51) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/package.json +2 -3
  3. package/resources/ach-transfers.d.ts +1 -1
  4. package/resources/declined-transactions.d.ts +1 -1
  5. package/resources/entities/entities.d.ts +7 -1
  6. package/resources/entities/entities.d.ts.map +1 -1
  7. package/resources/entities/entities.js.map +1 -1
  8. package/resources/entities/entities.mjs.map +1 -1
  9. package/resources/event-subscriptions.d.ts +16 -2
  10. package/resources/event-subscriptions.d.ts.map +1 -1
  11. package/resources/event-subscriptions.js.map +1 -1
  12. package/resources/event-subscriptions.mjs.map +1 -1
  13. package/resources/events.d.ts +4 -2
  14. package/resources/events.d.ts.map +1 -1
  15. package/resources/events.js.map +1 -1
  16. package/resources/events.mjs.map +1 -1
  17. package/resources/files.d.ts +3 -4
  18. package/resources/files.d.ts.map +1 -1
  19. package/resources/files.js.map +1 -1
  20. package/resources/files.mjs.map +1 -1
  21. package/resources/oauth-connections.d.ts +16 -0
  22. package/resources/oauth-connections.d.ts.map +1 -1
  23. package/resources/oauth-connections.js.map +1 -1
  24. package/resources/oauth-connections.mjs.map +1 -1
  25. package/resources/simulations/ach-transfers.d.ts +1 -1
  26. package/resources/simulations/ach-transfers.js +1 -1
  27. package/resources/simulations/ach-transfers.mjs +1 -1
  28. package/resources/simulations/cards.d.ts +1 -1
  29. package/resources/simulations/real-time-payments-transfers.d.ts +4 -53
  30. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  31. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  32. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  33. package/resources/transactions.d.ts +4 -53
  34. package/resources/transactions.d.ts.map +1 -1
  35. package/resources/transactions.js.map +1 -1
  36. package/resources/transactions.mjs.map +1 -1
  37. package/src/resources/ach-transfers.ts +1 -1
  38. package/src/resources/declined-transactions.ts +1 -1
  39. package/src/resources/entities/entities.ts +8 -1
  40. package/src/resources/event-subscriptions.ts +20 -0
  41. package/src/resources/events.ts +6 -0
  42. package/src/resources/files.ts +3 -4
  43. package/src/resources/oauth-connections.ts +20 -1
  44. package/src/resources/simulations/ach-transfers.ts +1 -1
  45. package/src/resources/simulations/cards.ts +1 -1
  46. package/src/resources/simulations/real-time-payments-transfers.ts +3 -60
  47. package/src/resources/transactions.ts +2 -60
  48. package/src/version.ts +1 -1
  49. package/version.d.ts +1 -1
  50. package/version.js +1 -1
  51. package/version.mjs +1 -1
@@ -82,6 +82,12 @@ export interface EventSubscription {
82
82
  */
83
83
  idempotency_key: string | null;
84
84
 
85
+ /**
86
+ * If specified, this subscription will only receive webhooks for Events associated
87
+ * with this OAuth Connection.
88
+ */
89
+ oauth_connection_id: string | null;
90
+
85
91
  /**
86
92
  * If specified, this subscription will only receive webhooks for Events with the
87
93
  * specified `category`.
@@ -150,6 +156,8 @@ export interface EventSubscription {
150
156
  * Transfer Return is created.
151
157
  * - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
152
158
  * Transfer Return is updated.
159
+ * - `inbound_mail_item.created` - Occurs whenever an Inbound Mail Item is created.
160
+ * - `inbound_mail_item.updated` - Occurs whenever an Inbound Mail Item is updated.
153
161
  * - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
154
162
  * Drawdown Request is created.
155
163
  * - `inbound_wire_transfer.created` - Occurs whenever an Inbound Wire Transfer is
@@ -255,6 +263,8 @@ export interface EventSubscription {
255
263
  | 'inbound_ach_transfer.updated'
256
264
  | 'inbound_ach_transfer_return.created'
257
265
  | 'inbound_ach_transfer_return.updated'
266
+ | 'inbound_mail_item.created'
267
+ | 'inbound_mail_item.updated'
258
268
  | 'inbound_wire_drawdown_request.created'
259
269
  | 'inbound_wire_transfer.created'
260
270
  | 'inbound_wire_transfer.updated'
@@ -319,6 +329,12 @@ export interface EventSubscriptionCreateParams {
319
329
  */
320
330
  url: string;
321
331
 
332
+ /**
333
+ * If specified, this subscription will only receive webhooks for Events associated
334
+ * with the specified OAuth Connection.
335
+ */
336
+ oauth_connection_id?: string;
337
+
322
338
  /**
323
339
  * If specified, this subscription will only receive webhooks for Events with the
324
340
  * specified `category`.
@@ -387,6 +403,8 @@ export interface EventSubscriptionCreateParams {
387
403
  * Transfer Return is created.
388
404
  * - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
389
405
  * Transfer Return is updated.
406
+ * - `inbound_mail_item.created` - Occurs whenever an Inbound Mail Item is created.
407
+ * - `inbound_mail_item.updated` - Occurs whenever an Inbound Mail Item is updated.
390
408
  * - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
391
409
  * Drawdown Request is created.
392
410
  * - `inbound_wire_transfer.created` - Occurs whenever an Inbound Wire Transfer is
@@ -492,6 +510,8 @@ export interface EventSubscriptionCreateParams {
492
510
  | 'inbound_ach_transfer.updated'
493
511
  | 'inbound_ach_transfer_return.created'
494
512
  | 'inbound_ach_transfer_return.updated'
513
+ | 'inbound_mail_item.created'
514
+ | 'inbound_mail_item.updated'
495
515
  | 'inbound_wire_drawdown_request.created'
496
516
  | 'inbound_wire_transfer.created'
497
517
  | 'inbound_wire_transfer.updated'
@@ -122,6 +122,8 @@ export interface Event {
122
122
  * Transfer Return is created.
123
123
  * - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
124
124
  * Transfer Return is updated.
125
+ * - `inbound_mail_item.created` - Occurs whenever an Inbound Mail Item is created.
126
+ * - `inbound_mail_item.updated` - Occurs whenever an Inbound Mail Item is updated.
125
127
  * - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
126
128
  * Drawdown Request is created.
127
129
  * - `inbound_wire_transfer.created` - Occurs whenever an Inbound Wire Transfer is
@@ -227,6 +229,8 @@ export interface Event {
227
229
  | 'inbound_ach_transfer.updated'
228
230
  | 'inbound_ach_transfer_return.created'
229
231
  | 'inbound_ach_transfer_return.updated'
232
+ | 'inbound_mail_item.created'
233
+ | 'inbound_mail_item.updated'
230
234
  | 'inbound_wire_drawdown_request.created'
231
235
  | 'inbound_wire_transfer.created'
232
236
  | 'inbound_wire_transfer.updated'
@@ -337,6 +341,8 @@ export namespace EventListParams {
337
341
  | 'inbound_ach_transfer.updated'
338
342
  | 'inbound_ach_transfer_return.created'
339
343
  | 'inbound_ach_transfer_return.updated'
344
+ | 'inbound_mail_item.created'
345
+ | 'inbound_mail_item.updated'
340
346
  | 'inbound_wire_drawdown_request.created'
341
347
  | 'inbound_wire_transfer.created'
342
348
  | 'inbound_wire_transfer.updated'
@@ -103,8 +103,7 @@ export interface File {
103
103
  * deposits.
104
104
  * - `check_image_back` - An image of the back of a check, used for check deposits.
105
105
  * - `mailed_check_image` - An image of a check that was mailed to a recipient.
106
- * - `check_deposit_mail_item` - A scanned mail item sent to Increase containing a
107
- * check to deposit.
106
+ * - `inbound_mail_item` - A scanned mail item sent to Increase.
108
107
  * - `form_1099_int` - IRS Form 1099-INT.
109
108
  * - `form_ss_4` - IRS Form SS-4.
110
109
  * - `identity_document` - An image of a government-issued ID.
@@ -132,7 +131,7 @@ export interface File {
132
131
  | 'check_image_front'
133
132
  | 'check_image_back'
134
133
  | 'mailed_check_image'
135
- | 'check_deposit_mail_item'
134
+ | 'inbound_mail_item'
136
135
  | 'form_1099_int'
137
136
  | 'form_ss_4'
138
137
  | 'identity_document'
@@ -262,7 +261,7 @@ export namespace FileListParams {
262
261
  | 'check_image_front'
263
262
  | 'check_image_back'
264
263
  | 'mailed_check_image'
265
- | 'check_deposit_mail_item'
264
+ | 'inbound_mail_item'
266
265
  | 'form_1099_int'
267
266
  | 'form_ss_4'
268
267
  | 'identity_document'
@@ -52,6 +52,12 @@ export interface OAuthConnection {
52
52
  */
53
53
  created_at: string;
54
54
 
55
+ /**
56
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
57
+ * Connection was deleted.
58
+ */
59
+ deleted_at: string | null;
60
+
55
61
  /**
56
62
  * The identifier of the Group that has authorized your OAuth application.
57
63
  */
@@ -72,7 +78,20 @@ export interface OAuthConnection {
72
78
  type: 'oauth_connection';
73
79
  }
74
80
 
75
- export interface OAuthConnectionListParams extends PageParams {}
81
+ export interface OAuthConnectionListParams extends PageParams {
82
+ status?: OAuthConnectionListParams.Status;
83
+ }
84
+
85
+ export namespace OAuthConnectionListParams {
86
+ export interface Status {
87
+ /**
88
+ * Filter to OAuth Connections by their status. By default, return only the
89
+ * `active` ones. For GET requests, this should be encoded as a comma-delimited
90
+ * string, such as `?in=one,two,three`.
91
+ */
92
+ in?: Array<'active' | 'inactive'>;
93
+ }
94
+ }
76
95
 
77
96
  export namespace OAuthConnections {
78
97
  export import OAuthConnection = OAuthConnectionsAPI.OAuthConnection;
@@ -13,7 +13,7 @@ export class ACHTransfers extends APIResource {
13
13
  * transfer may be either a credit or a debit depending on if the `amount` is
14
14
  * positive or negative. The result of calling this API will contain the created
15
15
  * transfer. You can pass a `resolve_at` parameter to allow for a window to
16
- * [action on the Inbound ACH Transfer](https://increase.com/documentation/inbound-ach-transfers#inbound-ach-transfers).
16
+ * [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers).
17
17
  * Alternatively, if you don't pass the `resolve_at` parameter the result will
18
18
  * contain either a [Transaction](#transactions) or a
19
19
  * [Declined Transaction](#declined-transactions) depending on whether or not the
@@ -1134,7 +1134,7 @@ export namespace CardAuthorizationSimulation {
1134
1134
  * originating and receiving bank. Along with the amount, date, and originating
1135
1135
  * routing number, this can be used to identify the ACH transfer at either bank.
1136
1136
  * ACH trace numbers are not unique, but are
1137
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
1137
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
1138
1138
  */
1139
1139
  trace_number: string;
1140
1140
  }
@@ -1133,7 +1133,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1133
1133
  * originating and receiving bank. Along with the amount, date, and originating
1134
1134
  * routing number, this can be used to identify the ACH transfer at either bank.
1135
1135
  * ACH trace numbers are not unique, but are
1136
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
1136
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
1137
1137
  */
1138
1138
  trace_number: string;
1139
1139
  }
@@ -1337,8 +1337,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1337
1337
  * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
1338
1338
  * Intention: details will be under the `inbound_ach_transfer_return_intention`
1339
1339
  * object.
1340
- * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
1341
- * object.
1342
1340
  * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
1343
1341
  * details will be under the `inbound_international_ach_transfer` object.
1344
1342
  * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
@@ -1386,7 +1384,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1386
1384
  | 'fee_payment'
1387
1385
  | 'inbound_ach_transfer'
1388
1386
  | 'inbound_ach_transfer_return_intention'
1389
- | 'inbound_check'
1390
1387
  | 'inbound_international_ach_transfer'
1391
1388
  | 'inbound_real_time_payments_transfer_confirmation'
1392
1389
  | 'inbound_wire_drawdown_payment_reversal'
@@ -1439,12 +1436,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1439
1436
  */
1440
1437
  inbound_ach_transfer: Source.InboundACHTransfer | null;
1441
1438
 
1442
- /**
1443
- * An Inbound Check object. This field will be present in the JSON response if and
1444
- * only if `category` is equal to `inbound_check`.
1445
- */
1446
- inbound_check: Source.InboundCheck | null;
1447
-
1448
1439
  /**
1449
1440
  * An Inbound International ACH Transfer object. This field will be present in the
1450
1441
  * JSON response if and only if `category` is equal to
@@ -3550,7 +3541,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3550
3541
  * originating and receiving bank. Along with the amount, date, and originating
3551
3542
  * routing number, this can be used to identify the ACH transfer at either bank.
3552
3543
  * ACH trace numbers are not unique, but are
3553
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
3544
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
3554
3545
  */
3555
3546
  trace_number: string;
3556
3547
 
@@ -3600,54 +3591,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3600
3591
  }
3601
3592
  }
3602
3593
 
3603
- /**
3604
- * An Inbound Check object. This field will be present in the JSON response if and
3605
- * only if `category` is equal to `inbound_check`.
3606
- */
3607
- export interface InboundCheck {
3608
- /**
3609
- * The amount in the minor unit of the destination account currency. For dollars,
3610
- * for example, this is cents.
3611
- */
3612
- amount: number;
3613
-
3614
- /**
3615
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
3616
- * bank depositing this check. In some rare cases, this is not transmitted via
3617
- * Check21 and the value will be null.
3618
- */
3619
- bank_of_first_deposit_routing_number: string | null;
3620
-
3621
- /**
3622
- * The front image of the check. This is a black and white TIFF image file.
3623
- */
3624
- check_front_image_file_id: string | null;
3625
-
3626
- /**
3627
- * The number of the check. This field is set by the depositing bank and can be
3628
- * unreliable.
3629
- */
3630
- check_number: string | null;
3631
-
3632
- /**
3633
- * The rear image of the check. This is a black and white TIFF image file.
3634
- */
3635
- check_rear_image_file_id: string | null;
3636
-
3637
- /**
3638
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3639
- * transaction's currency.
3640
- *
3641
- * - `CAD` - Canadian Dollar (CAD)
3642
- * - `CHF` - Swiss Franc (CHF)
3643
- * - `EUR` - Euro (EUR)
3644
- * - `GBP` - British Pound (GBP)
3645
- * - `JPY` - Japanese Yen (JPY)
3646
- * - `USD` - US Dollar (USD)
3647
- */
3648
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
3649
- }
3650
-
3651
3594
  /**
3652
3595
  * An Inbound International ACH Transfer object. This field will be present in the
3653
3596
  * JSON response if and only if `category` is equal to
@@ -3931,7 +3874,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3931
3874
  * originating and receiving bank. Along with the amount, date, and originating
3932
3875
  * routing number, this can be used to identify the ACH transfer at either bank.
3933
3876
  * ACH trace numbers are not unique, but are
3934
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
3877
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
3935
3878
  */
3936
3879
  trace_number: string;
3937
3880
  }
@@ -201,8 +201,6 @@ export namespace Transaction {
201
201
  * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
202
202
  * Intention: details will be under the `inbound_ach_transfer_return_intention`
203
203
  * object.
204
- * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
205
- * object.
206
204
  * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
207
205
  * details will be under the `inbound_international_ach_transfer` object.
208
206
  * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
@@ -250,7 +248,6 @@ export namespace Transaction {
250
248
  | 'fee_payment'
251
249
  | 'inbound_ach_transfer'
252
250
  | 'inbound_ach_transfer_return_intention'
253
- | 'inbound_check'
254
251
  | 'inbound_international_ach_transfer'
255
252
  | 'inbound_real_time_payments_transfer_confirmation'
256
253
  | 'inbound_wire_drawdown_payment_reversal'
@@ -303,12 +300,6 @@ export namespace Transaction {
303
300
  */
304
301
  inbound_ach_transfer: Source.InboundACHTransfer | null;
305
302
 
306
- /**
307
- * An Inbound Check object. This field will be present in the JSON response if and
308
- * only if `category` is equal to `inbound_check`.
309
- */
310
- inbound_check: Source.InboundCheck | null;
311
-
312
303
  /**
313
304
  * An Inbound International ACH Transfer object. This field will be present in the
314
305
  * JSON response if and only if `category` is equal to
@@ -2414,7 +2405,7 @@ export namespace Transaction {
2414
2405
  * originating and receiving bank. Along with the amount, date, and originating
2415
2406
  * routing number, this can be used to identify the ACH transfer at either bank.
2416
2407
  * ACH trace numbers are not unique, but are
2417
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
2408
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
2418
2409
  */
2419
2410
  trace_number: string;
2420
2411
 
@@ -2464,54 +2455,6 @@ export namespace Transaction {
2464
2455
  }
2465
2456
  }
2466
2457
 
2467
- /**
2468
- * An Inbound Check object. This field will be present in the JSON response if and
2469
- * only if `category` is equal to `inbound_check`.
2470
- */
2471
- export interface InboundCheck {
2472
- /**
2473
- * The amount in the minor unit of the destination account currency. For dollars,
2474
- * for example, this is cents.
2475
- */
2476
- amount: number;
2477
-
2478
- /**
2479
- * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
2480
- * bank depositing this check. In some rare cases, this is not transmitted via
2481
- * Check21 and the value will be null.
2482
- */
2483
- bank_of_first_deposit_routing_number: string | null;
2484
-
2485
- /**
2486
- * The front image of the check. This is a black and white TIFF image file.
2487
- */
2488
- check_front_image_file_id: string | null;
2489
-
2490
- /**
2491
- * The number of the check. This field is set by the depositing bank and can be
2492
- * unreliable.
2493
- */
2494
- check_number: string | null;
2495
-
2496
- /**
2497
- * The rear image of the check. This is a black and white TIFF image file.
2498
- */
2499
- check_rear_image_file_id: string | null;
2500
-
2501
- /**
2502
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2503
- * transaction's currency.
2504
- *
2505
- * - `CAD` - Canadian Dollar (CAD)
2506
- * - `CHF` - Swiss Franc (CHF)
2507
- * - `EUR` - Euro (EUR)
2508
- * - `GBP` - British Pound (GBP)
2509
- * - `JPY` - Japanese Yen (JPY)
2510
- * - `USD` - US Dollar (USD)
2511
- */
2512
- currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
2513
- }
2514
-
2515
2458
  /**
2516
2459
  * An Inbound International ACH Transfer object. This field will be present in the
2517
2460
  * JSON response if and only if `category` is equal to
@@ -2795,7 +2738,7 @@ export namespace Transaction {
2795
2738
  * originating and receiving bank. Along with the amount, date, and originating
2796
2739
  * routing number, this can be used to identify the ACH transfer at either bank.
2797
2740
  * ACH trace numbers are not unique, but are
2798
- * [used to correlate returns](https://increase.com/documentation/ach#returns).
2741
+ * [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
2799
2742
  */
2800
2743
  trace_number: string;
2801
2744
  }
@@ -3440,7 +3383,6 @@ export namespace TransactionListParams {
3440
3383
  | 'fee_payment'
3441
3384
  | 'inbound_ach_transfer'
3442
3385
  | 'inbound_ach_transfer_return_intention'
3443
- | 'inbound_check'
3444
3386
  | 'inbound_international_ach_transfer'
3445
3387
  | 'inbound_real_time_payments_transfer_confirmation'
3446
3388
  | 'inbound_wire_drawdown_payment_reversal'
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.42.0'; // x-release-please-version
1
+ export const VERSION = '0.44.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.42.0";
1
+ export declare const VERSION = "0.44.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.42.0'; // x-release-please-version
4
+ exports.VERSION = '0.44.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.42.0'; // x-release-please-version
1
+ export const VERSION = '0.44.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map