stripe 18.4.0-beta.1 → 18.4.0-beta.2

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.
@@ -62,6 +62,11 @@ declare module 'stripe' {
62
62
  * The Recipient Configuration allows the Account to receive funds.
63
63
  */
64
64
  recipient?: Configuration.Recipient;
65
+
66
+ /**
67
+ * The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
68
+ */
69
+ storer?: Configuration.Storer;
65
70
  }
66
71
 
67
72
  namespace Configuration {
@@ -1248,6 +1253,160 @@ declare module 'stripe' {
1248
1253
  }
1249
1254
  }
1250
1255
  }
1256
+
1257
+ interface Storer {
1258
+ /**
1259
+ * Capabilities to request on the Storer Configuration.
1260
+ */
1261
+ capabilities?: Storer.Capabilities;
1262
+ }
1263
+
1264
+ namespace Storer {
1265
+ interface Capabilities {
1266
+ /**
1267
+ * Can provision a financial address to credit/debit a FinancialAccount.
1268
+ */
1269
+ financial_addresses?: Capabilities.FinancialAddresses;
1270
+
1271
+ /**
1272
+ * Can hold storage-type funds on Stripe.
1273
+ */
1274
+ holds_currencies?: Capabilities.HoldsCurrencies;
1275
+
1276
+ /**
1277
+ * Can pull funds from an external source, owned by yourself, to a FinancialAccount.
1278
+ */
1279
+ inbound_transfers?: Capabilities.InboundTransfers;
1280
+
1281
+ /**
1282
+ * Can send funds from a FinancialAccount to a destination owned by someone else.
1283
+ */
1284
+ outbound_payments?: Capabilities.OutboundPayments;
1285
+
1286
+ /**
1287
+ * Can send funds from a FinancialAccount to a destination owned by yourself.
1288
+ */
1289
+ outbound_transfers?: Capabilities.OutboundTransfers;
1290
+ }
1291
+
1292
+ namespace Capabilities {
1293
+ interface FinancialAddresses {
1294
+ /**
1295
+ * Can provision a bank-account-like financial address (VBAN) to credit/debit a FinancialAccount.
1296
+ */
1297
+ bank_accounts?: FinancialAddresses.BankAccounts;
1298
+ }
1299
+
1300
+ namespace FinancialAddresses {
1301
+ interface BankAccounts {
1302
+ /**
1303
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1304
+ */
1305
+ requested: boolean;
1306
+ }
1307
+ }
1308
+
1309
+ interface HoldsCurrencies {
1310
+ /**
1311
+ * Can hold storage-type funds on Stripe in GBP.
1312
+ */
1313
+ gbp?: HoldsCurrencies.Gbp;
1314
+ }
1315
+
1316
+ namespace HoldsCurrencies {
1317
+ interface Gbp {
1318
+ /**
1319
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1320
+ */
1321
+ requested: boolean;
1322
+ }
1323
+ }
1324
+
1325
+ interface InboundTransfers {
1326
+ /**
1327
+ * Can pull funds from an external bank account owned by yourself to a FinancialAccount.
1328
+ */
1329
+ bank_accounts?: InboundTransfers.BankAccounts;
1330
+ }
1331
+
1332
+ namespace InboundTransfers {
1333
+ interface BankAccounts {
1334
+ /**
1335
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1336
+ */
1337
+ requested: boolean;
1338
+ }
1339
+ }
1340
+
1341
+ interface OutboundPayments {
1342
+ /**
1343
+ * Can send funds from a FinancialAccount to a bank account owned by someone else.
1344
+ */
1345
+ bank_accounts?: OutboundPayments.BankAccounts;
1346
+
1347
+ /**
1348
+ * Can send funds from a FinancialAccount to a debit card owned by someone else.
1349
+ */
1350
+ cards?: OutboundPayments.Cards;
1351
+
1352
+ /**
1353
+ * Can send funds from a FinancialAccount to another FinancialAccount owned by someone else.
1354
+ */
1355
+ financial_accounts?: OutboundPayments.FinancialAccounts;
1356
+ }
1357
+
1358
+ namespace OutboundPayments {
1359
+ interface BankAccounts {
1360
+ /**
1361
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1362
+ */
1363
+ requested: boolean;
1364
+ }
1365
+
1366
+ interface Cards {
1367
+ /**
1368
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1369
+ */
1370
+ requested: boolean;
1371
+ }
1372
+
1373
+ interface FinancialAccounts {
1374
+ /**
1375
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1376
+ */
1377
+ requested: boolean;
1378
+ }
1379
+ }
1380
+
1381
+ interface OutboundTransfers {
1382
+ /**
1383
+ * Can send funds from a FinancialAccount to a bank account owned by yourself.
1384
+ */
1385
+ bank_accounts?: OutboundTransfers.BankAccounts;
1386
+
1387
+ /**
1388
+ * Can send funds from a FinancialAccount to another FinancialAccount owned by yourself.
1389
+ */
1390
+ financial_accounts?: OutboundTransfers.FinancialAccounts;
1391
+ }
1392
+
1393
+ namespace OutboundTransfers {
1394
+ interface BankAccounts {
1395
+ /**
1396
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1397
+ */
1398
+ requested: boolean;
1399
+ }
1400
+
1401
+ interface FinancialAccounts {
1402
+ /**
1403
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
1404
+ */
1405
+ requested: boolean;
1406
+ }
1407
+ }
1408
+ }
1409
+ }
1251
1410
  }
1252
1411
 
1253
1412
  type Dashboard = 'express' | 'full' | 'none';
@@ -5058,6 +5217,7 @@ declare module 'stripe' {
5058
5217
  | 'configuration.customer'
5059
5218
  | 'configuration.merchant'
5060
5219
  | 'configuration.recipient'
5220
+ | 'configuration.storer'
5061
5221
  | 'defaults'
5062
5222
  | 'identity'
5063
5223
  | 'requirements';
@@ -5077,6 +5237,7 @@ declare module 'stripe' {
5077
5237
  | 'configuration.customer'
5078
5238
  | 'configuration.merchant'
5079
5239
  | 'configuration.recipient'
5240
+ | 'configuration.storer'
5080
5241
  | 'defaults'
5081
5242
  | 'identity'
5082
5243
  | 'requirements';
@@ -5142,6 +5303,11 @@ declare module 'stripe' {
5142
5303
  * The Recipient Configuration allows the Account to receive funds.
5143
5304
  */
5144
5305
  recipient?: Configuration.Recipient;
5306
+
5307
+ /**
5308
+ * The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
5309
+ */
5310
+ storer?: Configuration.Storer;
5145
5311
  }
5146
5312
 
5147
5313
  namespace Configuration {
@@ -6345,6 +6511,160 @@ declare module 'stripe' {
6345
6511
  }
6346
6512
  }
6347
6513
  }
6514
+
6515
+ interface Storer {
6516
+ /**
6517
+ * Capabilities to request on the Storer Configuration.
6518
+ */
6519
+ capabilities?: Storer.Capabilities;
6520
+ }
6521
+
6522
+ namespace Storer {
6523
+ interface Capabilities {
6524
+ /**
6525
+ * Can provision a financial address to credit/debit a FinancialAccount.
6526
+ */
6527
+ financial_addresses?: Capabilities.FinancialAddresses;
6528
+
6529
+ /**
6530
+ * Can hold storage-type funds on Stripe.
6531
+ */
6532
+ holds_currencies?: Capabilities.HoldsCurrencies;
6533
+
6534
+ /**
6535
+ * Can pull funds from an external source, owned by yourself, to a FinancialAccount.
6536
+ */
6537
+ inbound_transfers?: Capabilities.InboundTransfers;
6538
+
6539
+ /**
6540
+ * Can send funds from a FinancialAccount to a destination owned by someone else.
6541
+ */
6542
+ outbound_payments?: Capabilities.OutboundPayments;
6543
+
6544
+ /**
6545
+ * Can send funds from a FinancialAccount to a destination owned by yourself.
6546
+ */
6547
+ outbound_transfers?: Capabilities.OutboundTransfers;
6548
+ }
6549
+
6550
+ namespace Capabilities {
6551
+ interface FinancialAddresses {
6552
+ /**
6553
+ * Can provision a bank-account-like financial address (VBAN) to credit/debit a FinancialAccount.
6554
+ */
6555
+ bank_accounts?: FinancialAddresses.BankAccounts;
6556
+ }
6557
+
6558
+ namespace FinancialAddresses {
6559
+ interface BankAccounts {
6560
+ /**
6561
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6562
+ */
6563
+ requested?: boolean;
6564
+ }
6565
+ }
6566
+
6567
+ interface HoldsCurrencies {
6568
+ /**
6569
+ * Can hold storage-type funds on Stripe in GBP.
6570
+ */
6571
+ gbp?: HoldsCurrencies.Gbp;
6572
+ }
6573
+
6574
+ namespace HoldsCurrencies {
6575
+ interface Gbp {
6576
+ /**
6577
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6578
+ */
6579
+ requested?: boolean;
6580
+ }
6581
+ }
6582
+
6583
+ interface InboundTransfers {
6584
+ /**
6585
+ * Can pull funds from an external bank account owned by yourself to a FinancialAccount.
6586
+ */
6587
+ bank_accounts?: InboundTransfers.BankAccounts;
6588
+ }
6589
+
6590
+ namespace InboundTransfers {
6591
+ interface BankAccounts {
6592
+ /**
6593
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6594
+ */
6595
+ requested?: boolean;
6596
+ }
6597
+ }
6598
+
6599
+ interface OutboundPayments {
6600
+ /**
6601
+ * Can send funds from a FinancialAccount to a bank account owned by someone else.
6602
+ */
6603
+ bank_accounts?: OutboundPayments.BankAccounts;
6604
+
6605
+ /**
6606
+ * Can send funds from a FinancialAccount to a debit card owned by someone else.
6607
+ */
6608
+ cards?: OutboundPayments.Cards;
6609
+
6610
+ /**
6611
+ * Can send funds from a FinancialAccount to another FinancialAccount owned by someone else.
6612
+ */
6613
+ financial_accounts?: OutboundPayments.FinancialAccounts;
6614
+ }
6615
+
6616
+ namespace OutboundPayments {
6617
+ interface BankAccounts {
6618
+ /**
6619
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6620
+ */
6621
+ requested?: boolean;
6622
+ }
6623
+
6624
+ interface Cards {
6625
+ /**
6626
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6627
+ */
6628
+ requested?: boolean;
6629
+ }
6630
+
6631
+ interface FinancialAccounts {
6632
+ /**
6633
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6634
+ */
6635
+ requested?: boolean;
6636
+ }
6637
+ }
6638
+
6639
+ interface OutboundTransfers {
6640
+ /**
6641
+ * Can send funds from a FinancialAccount to a bank account owned by yourself.
6642
+ */
6643
+ bank_accounts?: OutboundTransfers.BankAccounts;
6644
+
6645
+ /**
6646
+ * Can send funds from a FinancialAccount to another FinancialAccount owned by yourself.
6647
+ */
6648
+ financial_accounts?: OutboundTransfers.FinancialAccounts;
6649
+ }
6650
+
6651
+ namespace OutboundTransfers {
6652
+ interface BankAccounts {
6653
+ /**
6654
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6655
+ */
6656
+ requested?: boolean;
6657
+ }
6658
+
6659
+ interface FinancialAccounts {
6660
+ /**
6661
+ * To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
6662
+ */
6663
+ requested?: boolean;
6664
+ }
6665
+ }
6666
+ }
6667
+ }
6348
6668
  }
6349
6669
 
6350
6670
  type Dashboard = 'express' | 'full' | 'none';
@@ -10155,6 +10475,7 @@ declare module 'stripe' {
10155
10475
  | 'configuration.customer'
10156
10476
  | 'configuration.merchant'
10157
10477
  | 'configuration.recipient'
10478
+ | 'configuration.storer'
10158
10479
  | 'defaults'
10159
10480
  | 'identity'
10160
10481
  | 'requirements';
@@ -10186,7 +10507,11 @@ declare module 'stripe' {
10186
10507
  }
10187
10508
 
10188
10509
  namespace AccountCloseParams {
10189
- type AppliedConfiguration = 'customer' | 'merchant' | 'recipient';
10510
+ type AppliedConfiguration =
10511
+ | 'customer'
10512
+ | 'merchant'
10513
+ | 'recipient'
10514
+ | 'storer';
10190
10515
  }
10191
10516
  }
10192
10517
 
@@ -19,6 +19,8 @@ declare module 'stripe' {
19
19
  | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
20
20
  | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
21
21
  | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
22
+ | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
23
+ | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEvent
22
24
  | Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
23
25
  | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
24
26
  | Stripe.Events.V1BillingMeterNoMeterFoundEvent
@@ -397,6 +399,55 @@ declare module 'stripe' {
397
399
  fetchRelatedObject(): Promise<V2.Core.Account>;
398
400
  }
399
401
 
402
+ /**
403
+ * Occurs when the status of an Account's storer configuration capability is updated.
404
+ */
405
+ export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
406
+ extends V2.EventBase {
407
+ type: 'v2.core.account[configuration.storer].capability_status_updated';
408
+ // Retrieves data specific to this event.
409
+ data: V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.Data;
410
+ // Object containing the reference to API resource relevant to the event.
411
+ related_object: Event.RelatedObject;
412
+ // Retrieves the object associated with the event.
413
+ fetchRelatedObject(): Promise<V2.Core.Account>;
414
+ }
415
+
416
+ namespace V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent {
417
+ export interface Data {
418
+ /**
419
+ * Open Enum. The capability which had its status updated.
420
+ */
421
+ updated_capability: Data.UpdatedCapability;
422
+ }
423
+
424
+ namespace Data {
425
+ export type UpdatedCapability =
426
+ | 'financial_addressses.bank_accounts'
427
+ | 'holds_currencies.eur'
428
+ | 'holds_currencies.gbp'
429
+ | 'holds_currencies.usd'
430
+ | 'inbound_transfers.bank_accounts'
431
+ | 'outbound_payments.bank_accounts'
432
+ | 'outbound_payments.cards'
433
+ | 'outbound_payments.financial_accounts'
434
+ | 'outbound_transfers.bank_accounts'
435
+ | 'outbound_transfers.financial_accounts';
436
+ }
437
+ }
438
+
439
+ /**
440
+ * Occurs when a Storer's configuration is updated.
441
+ */
442
+ export interface V2CoreAccountIncludingConfigurationStorerUpdatedEvent
443
+ extends V2.EventBase {
444
+ type: 'v2.core.account[configuration.storer].updated';
445
+ // Object containing the reference to API resource relevant to the event.
446
+ related_object: Event.RelatedObject;
447
+ // Retrieves the object associated with the event.
448
+ fetchRelatedObject(): Promise<V2.Core.Account>;
449
+ }
450
+
400
451
  /**
401
452
  * Occurs when an Adjustment is created.
402
453
  */
@@ -53,6 +53,8 @@ declare module 'stripe' {
53
53
  */
54
54
  status: FinancialAccount.Status;
55
55
 
56
+ status_details: FinancialAccount.StatusDetails | null;
57
+
56
58
  /**
57
59
  * If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
58
60
  */
@@ -351,6 +353,34 @@ declare module 'stripe' {
351
353
 
352
354
  type Status = 'closed' | 'open' | 'pending';
353
355
 
356
+ interface StatusDetails {
357
+ closed: StatusDetails.Closed | null;
358
+ }
359
+
360
+ namespace StatusDetails {
361
+ interface Closed {
362
+ forwarding_settings: Closed.ForwardingSettings | null;
363
+
364
+ reason: Closed.Reason;
365
+ }
366
+
367
+ namespace Closed {
368
+ interface ForwardingSettings {
369
+ /**
370
+ * The address to send forwarded payments to.
371
+ */
372
+ payment_method: string | null;
373
+
374
+ /**
375
+ * The address to send forwarded payouts to.
376
+ */
377
+ payout_method: string | null;
378
+ }
379
+
380
+ type Reason = 'account_closed' | 'closed_by_platform' | 'other';
381
+ }
382
+ }
383
+
354
384
  interface Storage {
355
385
  /**
356
386
  * The currencies that this FinancialAccount can hold.