@augustusbank/typescript-sdk 0.19.0 → 0.21.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 (42) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/accounts.d.mts +7 -7
  4. package/resources/accounts.d.mts.map +1 -1
  5. package/resources/accounts.d.ts +7 -7
  6. package/resources/accounts.d.ts.map +1 -1
  7. package/resources/conversions.d.mts +8 -8
  8. package/resources/conversions.d.mts.map +1 -1
  9. package/resources/conversions.d.ts +8 -8
  10. package/resources/conversions.d.ts.map +1 -1
  11. package/resources/deposits.d.mts +14 -14
  12. package/resources/deposits.d.mts.map +1 -1
  13. package/resources/deposits.d.ts +14 -14
  14. package/resources/deposits.d.ts.map +1 -1
  15. package/resources/payouts.d.mts +25 -25
  16. package/resources/payouts.d.mts.map +1 -1
  17. package/resources/payouts.d.ts +25 -25
  18. package/resources/payouts.d.ts.map +1 -1
  19. package/resources/returns.d.mts +3 -3
  20. package/resources/returns.d.mts.map +1 -1
  21. package/resources/returns.d.ts +3 -3
  22. package/resources/returns.d.ts.map +1 -1
  23. package/resources/transactions.d.mts +12 -12
  24. package/resources/transactions.d.mts.map +1 -1
  25. package/resources/transactions.d.ts +12 -12
  26. package/resources/transactions.d.ts.map +1 -1
  27. package/resources/webhooks.d.mts +41 -41
  28. package/resources/webhooks.d.mts.map +1 -1
  29. package/resources/webhooks.d.ts +41 -41
  30. package/resources/webhooks.d.ts.map +1 -1
  31. package/src/resources/accounts.ts +7 -7
  32. package/src/resources/conversions.ts +8 -8
  33. package/src/resources/deposits.ts +20 -20
  34. package/src/resources/payouts.ts +37 -37
  35. package/src/resources/returns.ts +3 -3
  36. package/src/resources/transactions.ts +18 -18
  37. package/src/resources/webhooks.ts +57 -41
  38. package/src/version.ts +1 -1
  39. package/version.d.mts +1 -1
  40. package/version.d.ts +1 -1
  41. package/version.js +1 -1
  42. package/version.mjs +1 -1
@@ -68,12 +68,16 @@ export namespace PayoutCreatedWebhookEvent {
68
68
  /**
69
69
  * Currency code (ISO 4217 currency code or crypto currency code).
70
70
  */
71
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
71
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
72
72
 
73
73
  /**
74
74
  * Bank account or crypto wallet the payout was sent to.
75
75
  */
76
- destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
76
+ destination:
77
+ | Payload.IbanFinancialAddress
78
+ | Payload.SortCodeFinancialAddress
79
+ | Payload.AbaFinancialAddress
80
+ | Payload.CryptoWalletFinancialAddress;
77
81
 
78
82
  /**
79
83
  * Failure details when status is failed, otherwise null.
@@ -112,7 +116,7 @@ export namespace PayoutCreatedWebhookEvent {
112
116
  }
113
117
 
114
118
  export namespace Payload {
115
- export interface UnionMember0 {
119
+ export interface IbanFinancialAddress {
116
120
  /**
117
121
  * Name of the account holder.
118
122
  */
@@ -134,7 +138,7 @@ export namespace PayoutCreatedWebhookEvent {
134
138
  type: 'iban';
135
139
  }
136
140
 
137
- export interface UnionMember1 {
141
+ export interface SortCodeFinancialAddress {
138
142
  /**
139
143
  * Name of the account holder.
140
144
  */
@@ -156,7 +160,7 @@ export namespace PayoutCreatedWebhookEvent {
156
160
  type: 'sort_code';
157
161
  }
158
162
 
159
- export interface UnionMember2 {
163
+ export interface AbaFinancialAddress {
160
164
  /**
161
165
  * Name of the account holder.
162
166
  */
@@ -178,7 +182,7 @@ export namespace PayoutCreatedWebhookEvent {
178
182
  type: 'aba';
179
183
  }
180
184
 
181
- export interface UnionMember3 {
185
+ export interface CryptoWalletFinancialAddress {
182
186
  /**
183
187
  * Wallet address on the specified blockchain.
184
188
  */
@@ -289,12 +293,16 @@ export namespace PayoutInitiatedWebhookEvent {
289
293
  /**
290
294
  * Currency code (ISO 4217 currency code or crypto currency code).
291
295
  */
292
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
296
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
293
297
 
294
298
  /**
295
299
  * Bank account or crypto wallet the payout was sent to.
296
300
  */
297
- destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
301
+ destination:
302
+ | Payload.IbanFinancialAddress
303
+ | Payload.SortCodeFinancialAddress
304
+ | Payload.AbaFinancialAddress
305
+ | Payload.CryptoWalletFinancialAddress;
298
306
 
299
307
  /**
300
308
  * Failure details when status is failed, otherwise null.
@@ -333,7 +341,7 @@ export namespace PayoutInitiatedWebhookEvent {
333
341
  }
334
342
 
335
343
  export namespace Payload {
336
- export interface UnionMember0 {
344
+ export interface IbanFinancialAddress {
337
345
  /**
338
346
  * Name of the account holder.
339
347
  */
@@ -355,7 +363,7 @@ export namespace PayoutInitiatedWebhookEvent {
355
363
  type: 'iban';
356
364
  }
357
365
 
358
- export interface UnionMember1 {
366
+ export interface SortCodeFinancialAddress {
359
367
  /**
360
368
  * Name of the account holder.
361
369
  */
@@ -377,7 +385,7 @@ export namespace PayoutInitiatedWebhookEvent {
377
385
  type: 'sort_code';
378
386
  }
379
387
 
380
- export interface UnionMember2 {
388
+ export interface AbaFinancialAddress {
381
389
  /**
382
390
  * Name of the account holder.
383
391
  */
@@ -399,7 +407,7 @@ export namespace PayoutInitiatedWebhookEvent {
399
407
  type: 'aba';
400
408
  }
401
409
 
402
- export interface UnionMember3 {
410
+ export interface CryptoWalletFinancialAddress {
403
411
  /**
404
412
  * Wallet address on the specified blockchain.
405
413
  */
@@ -510,12 +518,16 @@ export namespace PayoutPaidWebhookEvent {
510
518
  /**
511
519
  * Currency code (ISO 4217 currency code or crypto currency code).
512
520
  */
513
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
521
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
514
522
 
515
523
  /**
516
524
  * Bank account or crypto wallet the payout was sent to.
517
525
  */
518
- destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
526
+ destination:
527
+ | Payload.IbanFinancialAddress
528
+ | Payload.SortCodeFinancialAddress
529
+ | Payload.AbaFinancialAddress
530
+ | Payload.CryptoWalletFinancialAddress;
519
531
 
520
532
  /**
521
533
  * Failure details when status is failed, otherwise null.
@@ -554,7 +566,7 @@ export namespace PayoutPaidWebhookEvent {
554
566
  }
555
567
 
556
568
  export namespace Payload {
557
- export interface UnionMember0 {
569
+ export interface IbanFinancialAddress {
558
570
  /**
559
571
  * Name of the account holder.
560
572
  */
@@ -576,7 +588,7 @@ export namespace PayoutPaidWebhookEvent {
576
588
  type: 'iban';
577
589
  }
578
590
 
579
- export interface UnionMember1 {
591
+ export interface SortCodeFinancialAddress {
580
592
  /**
581
593
  * Name of the account holder.
582
594
  */
@@ -598,7 +610,7 @@ export namespace PayoutPaidWebhookEvent {
598
610
  type: 'sort_code';
599
611
  }
600
612
 
601
- export interface UnionMember2 {
613
+ export interface AbaFinancialAddress {
602
614
  /**
603
615
  * Name of the account holder.
604
616
  */
@@ -620,7 +632,7 @@ export namespace PayoutPaidWebhookEvent {
620
632
  type: 'aba';
621
633
  }
622
634
 
623
- export interface UnionMember3 {
635
+ export interface CryptoWalletFinancialAddress {
624
636
  /**
625
637
  * Wallet address on the specified blockchain.
626
638
  */
@@ -731,12 +743,16 @@ export namespace PayoutFailedWebhookEvent {
731
743
  /**
732
744
  * Currency code (ISO 4217 currency code or crypto currency code).
733
745
  */
734
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
746
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
735
747
 
736
748
  /**
737
749
  * Bank account or crypto wallet the payout was sent to.
738
750
  */
739
- destination: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
751
+ destination:
752
+ | Payload.IbanFinancialAddress
753
+ | Payload.SortCodeFinancialAddress
754
+ | Payload.AbaFinancialAddress
755
+ | Payload.CryptoWalletFinancialAddress;
740
756
 
741
757
  /**
742
758
  * Failure details when status is failed, otherwise null.
@@ -775,7 +791,7 @@ export namespace PayoutFailedWebhookEvent {
775
791
  }
776
792
 
777
793
  export namespace Payload {
778
- export interface UnionMember0 {
794
+ export interface IbanFinancialAddress {
779
795
  /**
780
796
  * Name of the account holder.
781
797
  */
@@ -797,7 +813,7 @@ export namespace PayoutFailedWebhookEvent {
797
813
  type: 'iban';
798
814
  }
799
815
 
800
- export interface UnionMember1 {
816
+ export interface SortCodeFinancialAddress {
801
817
  /**
802
818
  * Name of the account holder.
803
819
  */
@@ -819,7 +835,7 @@ export namespace PayoutFailedWebhookEvent {
819
835
  type: 'sort_code';
820
836
  }
821
837
 
822
- export interface UnionMember2 {
838
+ export interface AbaFinancialAddress {
823
839
  /**
824
840
  * Name of the account holder.
825
841
  */
@@ -841,7 +857,7 @@ export namespace PayoutFailedWebhookEvent {
841
857
  type: 'aba';
842
858
  }
843
859
 
844
- export interface UnionMember3 {
860
+ export interface CryptoWalletFinancialAddress {
845
861
  /**
846
862
  * Wallet address on the specified blockchain.
847
863
  */
@@ -952,7 +968,7 @@ export namespace ReturnInitiatedWebhookEvent {
952
968
  /**
953
969
  * Currency code (ISO 4217 currency code or crypto currency code).
954
970
  */
955
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
971
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
956
972
 
957
973
  /**
958
974
  * ID of the parent deposit.
@@ -1067,7 +1083,7 @@ export namespace ReturnPaidWebhookEvent {
1067
1083
  /**
1068
1084
  * Currency code (ISO 4217 currency code or crypto currency code).
1069
1085
  */
1070
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1086
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1071
1087
 
1072
1088
  /**
1073
1089
  * ID of the parent deposit.
@@ -1182,7 +1198,7 @@ export namespace ReturnFailedWebhookEvent {
1182
1198
  /**
1183
1199
  * Currency code (ISO 4217 currency code or crypto currency code).
1184
1200
  */
1185
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1201
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1186
1202
 
1187
1203
  /**
1188
1204
  * ID of the parent deposit.
@@ -1297,7 +1313,7 @@ export namespace ReturnReturnedWebhookEvent {
1297
1313
  /**
1298
1314
  * Currency code (ISO 4217 currency code or crypto currency code).
1299
1315
  */
1300
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1316
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1301
1317
 
1302
1318
  /**
1303
1319
  * ID of the parent deposit.
@@ -1417,7 +1433,7 @@ export namespace DepositReceivedWebhookEvent {
1417
1433
  /**
1418
1434
  * Supported fiat or crypto currency code for the deposit amount.
1419
1435
  */
1420
- currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1436
+ currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1421
1437
 
1422
1438
  /**
1423
1439
  * ID of the merchant account that received the deposit.
@@ -1425,7 +1441,7 @@ export namespace DepositReceivedWebhookEvent {
1425
1441
  destination_account_id: string;
1426
1442
 
1427
1443
  /**
1428
- * Payment rail or blockchain used for the deposit.
1444
+ * Payment rail or blockchain used for the deposit, or null when unknown.
1429
1445
  */
1430
1446
  rail:
1431
1447
  | 'sepa_instant'
@@ -1459,7 +1475,7 @@ export namespace DepositReceivedWebhookEvent {
1459
1475
  /**
1460
1476
  * Counterparty bank account or crypto wallet that sent the funds.
1461
1477
  */
1462
- source: Payload.UnionMember0 | Payload.UnionMember1 | Payload.UnionMember2 | Payload.UnionMember3;
1478
+ source: Payload.Iban | Payload.UkSortCode | Payload.Aba | Payload.Wallet;
1463
1479
 
1464
1480
  /**
1465
1481
  * Current status of the deposit.
@@ -1483,7 +1499,7 @@ export namespace DepositReceivedWebhookEvent {
1483
1499
  }
1484
1500
 
1485
1501
  export namespace Payload {
1486
- export interface UnionMember0 {
1502
+ export interface Iban {
1487
1503
  /**
1488
1504
  * Name of the account holder.
1489
1505
  */
@@ -1505,7 +1521,7 @@ export namespace DepositReceivedWebhookEvent {
1505
1521
  type: 'iban';
1506
1522
  }
1507
1523
 
1508
- export interface UnionMember1 {
1524
+ export interface UkSortCode {
1509
1525
  /**
1510
1526
  * Name of the account holder.
1511
1527
  */
@@ -1527,7 +1543,7 @@ export namespace DepositReceivedWebhookEvent {
1527
1543
  type: 'sort_code';
1528
1544
  }
1529
1545
 
1530
- export interface UnionMember2 {
1546
+ export interface Aba {
1531
1547
  /**
1532
1548
  * Name of the account holder.
1533
1549
  */
@@ -1549,7 +1565,7 @@ export namespace DepositReceivedWebhookEvent {
1549
1565
  type: 'aba';
1550
1566
  }
1551
1567
 
1552
- export interface UnionMember3 {
1568
+ export interface Wallet {
1553
1569
  /**
1554
1570
  * Wallet address on the specified blockchain.
1555
1571
  */
@@ -1651,7 +1667,7 @@ export namespace ConversionCreatedWebhookEvent {
1651
1667
  /**
1652
1668
  * Source currency code.
1653
1669
  */
1654
- source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1670
+ source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1655
1671
 
1656
1672
  /**
1657
1673
  * Current status of the conversion.
@@ -1666,7 +1682,7 @@ export namespace ConversionCreatedWebhookEvent {
1666
1682
  /**
1667
1683
  * Target currency code.
1668
1684
  */
1669
- target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1685
+ target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1670
1686
 
1671
1687
  /**
1672
1688
  * Resource type discriminator.
@@ -1767,7 +1783,7 @@ export namespace ConversionCompletedWebhookEvent {
1767
1783
  /**
1768
1784
  * Source currency code.
1769
1785
  */
1770
- source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1786
+ source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1771
1787
 
1772
1788
  /**
1773
1789
  * Current status of the conversion.
@@ -1782,7 +1798,7 @@ export namespace ConversionCompletedWebhookEvent {
1782
1798
  /**
1783
1799
  * Target currency code.
1784
1800
  */
1785
- target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1801
+ target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1786
1802
 
1787
1803
  /**
1788
1804
  * Resource type discriminator.
@@ -1883,7 +1899,7 @@ export namespace ConversionFailedWebhookEvent {
1883
1899
  /**
1884
1900
  * Source currency code.
1885
1901
  */
1886
- source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1902
+ source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1887
1903
 
1888
1904
  /**
1889
1905
  * Current status of the conversion.
@@ -1898,7 +1914,7 @@ export namespace ConversionFailedWebhookEvent {
1898
1914
  /**
1899
1915
  * Target currency code.
1900
1916
  */
1901
- target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
1917
+ target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
1902
1918
 
1903
1919
  /**
1904
1920
  * Resource type discriminator.
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.19.0'; // x-release-please-version
1
+ export const VERSION = '0.21.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.19.0";
1
+ export declare const VERSION = "0.21.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.19.0";
1
+ export declare const VERSION = "0.21.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.19.0'; // x-release-please-version
4
+ exports.VERSION = '0.21.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.19.0'; // x-release-please-version
1
+ export const VERSION = '0.21.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map