@getivy/node-sdk 0.1.0-alpha.9 → 1.1.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 (231) hide show
  1. package/CHANGELOG.md +334 -0
  2. package/README.md +16 -26
  3. package/_shims/index.d.ts +2 -0
  4. package/_shims/index.js +5 -1
  5. package/_shims/index.mjs +5 -1
  6. package/core.d.ts +19 -5
  7. package/core.d.ts.map +1 -1
  8. package/core.js +25 -15
  9. package/core.js.map +1 -1
  10. package/core.mjs +26 -16
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +36 -18
  13. package/index.d.ts +36 -18
  14. package/index.d.ts.map +1 -1
  15. package/index.js +27 -8
  16. package/index.js.map +1 -1
  17. package/index.mjs +27 -8
  18. package/index.mjs.map +1 -1
  19. package/package.json +11 -33
  20. package/resource.d.ts +1 -1
  21. package/resource.d.ts.map +1 -1
  22. package/resource.js.map +1 -1
  23. package/resource.mjs.map +1 -1
  24. package/resources/balance.d.ts +8 -5
  25. package/resources/balance.d.ts.map +1 -1
  26. package/resources/banks.d.ts +82 -67
  27. package/resources/banks.d.ts.map +1 -1
  28. package/resources/beneficiary-payouts.d.ts +61 -0
  29. package/resources/beneficiary-payouts.d.ts.map +1 -0
  30. package/resources/beneficiary-payouts.js +16 -0
  31. package/resources/beneficiary-payouts.js.map +1 -0
  32. package/resources/beneficiary-payouts.mjs +12 -0
  33. package/resources/beneficiary-payouts.mjs.map +1 -0
  34. package/resources/capabilities.d.ts +1 -10
  35. package/resources/capabilities.d.ts.map +1 -1
  36. package/resources/charges.d.ts +28 -19
  37. package/resources/charges.d.ts.map +1 -1
  38. package/resources/checkoutsession.d.ts +275 -1360
  39. package/resources/checkoutsession.d.ts.map +1 -1
  40. package/resources/customers.d.ts +140 -10
  41. package/resources/customers.d.ts.map +1 -1
  42. package/resources/customers.js +9 -2
  43. package/resources/customers.js.map +1 -1
  44. package/resources/customers.mjs +9 -2
  45. package/resources/customers.mjs.map +1 -1
  46. package/resources/data/accounts.d.ts +83 -0
  47. package/resources/data/accounts.d.ts.map +1 -0
  48. package/resources/data/accounts.js +15 -0
  49. package/resources/data/accounts.js.map +1 -0
  50. package/resources/data/accounts.mjs +11 -0
  51. package/resources/data/accounts.mjs.map +1 -0
  52. package/resources/data/balances.d.ts +48 -0
  53. package/resources/data/balances.d.ts.map +1 -0
  54. package/resources/data/balances.js +15 -0
  55. package/resources/data/balances.js.map +1 -0
  56. package/resources/data/balances.mjs +11 -0
  57. package/resources/data/balances.mjs.map +1 -0
  58. package/resources/data/consent.d.ts +80 -0
  59. package/resources/data/consent.d.ts.map +1 -0
  60. package/resources/data/consent.js +21 -0
  61. package/resources/data/consent.js.map +1 -0
  62. package/resources/data/consent.mjs +17 -0
  63. package/resources/data/consent.mjs.map +1 -0
  64. package/resources/data/data.d.ts +26 -0
  65. package/resources/data/data.d.ts.map +1 -0
  66. package/resources/data/data.js +55 -0
  67. package/resources/data/data.js.map +1 -0
  68. package/resources/data/data.mjs +28 -0
  69. package/resources/data/data.mjs.map +1 -0
  70. package/resources/data/index.d.ts +7 -0
  71. package/resources/data/index.d.ts.map +1 -0
  72. package/resources/data/index.js +17 -0
  73. package/resources/data/index.js.map +1 -0
  74. package/resources/data/index.mjs +8 -0
  75. package/resources/data/index.mjs.map +1 -0
  76. package/resources/data/session.d.ts +258 -0
  77. package/resources/data/session.d.ts.map +1 -0
  78. package/resources/data/session.js +21 -0
  79. package/resources/data/session.js.map +1 -0
  80. package/resources/data/session.mjs +17 -0
  81. package/resources/data/session.mjs.map +1 -0
  82. package/resources/data/transactions.d.ts +175 -0
  83. package/resources/data/transactions.d.ts.map +1 -0
  84. package/resources/data/transactions.js +16 -0
  85. package/resources/data/transactions.js.map +1 -0
  86. package/resources/data/transactions.mjs +12 -0
  87. package/resources/data/transactions.mjs.map +1 -0
  88. package/resources/data.d.ts +2 -0
  89. package/resources/data.d.ts.map +1 -0
  90. package/resources/data.js +19 -0
  91. package/resources/data.js.map +1 -0
  92. package/resources/data.mjs +3 -0
  93. package/resources/data.mjs.map +1 -0
  94. package/resources/deposits.d.ts +165 -0
  95. package/resources/deposits.d.ts.map +1 -0
  96. package/resources/deposits.js +15 -0
  97. package/resources/deposits.js.map +1 -0
  98. package/resources/deposits.mjs +11 -0
  99. package/resources/deposits.mjs.map +1 -0
  100. package/resources/fx.d.ts +90 -0
  101. package/resources/fx.d.ts.map +1 -0
  102. package/resources/fx.js +22 -0
  103. package/resources/fx.js.map +1 -0
  104. package/resources/fx.mjs +18 -0
  105. package/resources/fx.mjs.map +1 -0
  106. package/resources/index.d.ts +13 -8
  107. package/resources/index.d.ts.map +1 -1
  108. package/resources/index.js +15 -5
  109. package/resources/index.js.map +1 -1
  110. package/resources/index.mjs +7 -2
  111. package/resources/index.mjs.map +1 -1
  112. package/resources/mandates.d.ts +55 -17
  113. package/resources/mandates.d.ts.map +1 -1
  114. package/resources/orders.d.ts +720 -743
  115. package/resources/orders.d.ts.map +1 -1
  116. package/resources/orders.js +13 -3
  117. package/resources/orders.js.map +1 -1
  118. package/resources/orders.mjs +13 -3
  119. package/resources/orders.mjs.map +1 -1
  120. package/resources/payouts.d.ts +219 -103
  121. package/resources/payouts.d.ts.map +1 -1
  122. package/resources/payouts.js +3 -4
  123. package/resources/payouts.js.map +1 -1
  124. package/resources/payouts.mjs +3 -4
  125. package/resources/payouts.mjs.map +1 -1
  126. package/resources/refunds.d.ts +53 -97
  127. package/resources/refunds.d.ts.map +1 -1
  128. package/resources/refunds.js +8 -12
  129. package/resources/refunds.js.map +1 -1
  130. package/resources/refunds.mjs +8 -12
  131. package/resources/refunds.mjs.map +1 -1
  132. package/resources/returns.d.ts +104 -0
  133. package/resources/returns.d.ts.map +1 -0
  134. package/resources/returns.js +21 -0
  135. package/resources/returns.js.map +1 -0
  136. package/resources/returns.mjs +17 -0
  137. package/resources/returns.mjs.map +1 -0
  138. package/resources/subaccounts.d.ts +15 -5
  139. package/resources/subaccounts.d.ts.map +1 -1
  140. package/resources/subaccounts.js.map +1 -1
  141. package/resources/subaccounts.mjs.map +1 -1
  142. package/resources/transactions.d.ts +174 -0
  143. package/resources/transactions.d.ts.map +1 -0
  144. package/resources/transactions.js +15 -0
  145. package/resources/transactions.js.map +1 -0
  146. package/resources/transactions.mjs +11 -0
  147. package/resources/transactions.mjs.map +1 -0
  148. package/resources/webhook/index.d.ts +3 -0
  149. package/resources/webhook/index.d.ts.map +1 -0
  150. package/resources/webhook/index.js +9 -0
  151. package/resources/webhook/index.js.map +1 -0
  152. package/resources/webhook/index.mjs +4 -0
  153. package/resources/webhook/index.mjs.map +1 -0
  154. package/resources/webhook/subscription.d.ts +152 -0
  155. package/resources/webhook/subscription.d.ts.map +1 -0
  156. package/resources/{webhooksubscription.js → webhook/subscription.js} +6 -6
  157. package/resources/webhook/subscription.js.map +1 -0
  158. package/resources/{webhooksubscription.mjs → webhook/subscription.mjs} +4 -4
  159. package/resources/webhook/subscription.mjs.map +1 -0
  160. package/resources/webhook/webhook.d.ts +28 -0
  161. package/resources/webhook/webhook.d.ts.map +1 -0
  162. package/resources/webhook/webhook.js +45 -0
  163. package/resources/webhook/webhook.js.map +1 -0
  164. package/resources/webhook/webhook.mjs +18 -0
  165. package/resources/webhook/webhook.mjs.map +1 -0
  166. package/resources/webhook.d.ts +2 -0
  167. package/resources/webhook.d.ts.map +1 -0
  168. package/resources/webhook.js +19 -0
  169. package/resources/webhook.js.map +1 -0
  170. package/resources/webhook.mjs +3 -0
  171. package/resources/webhook.mjs.map +1 -0
  172. package/resources.d.ts +2 -0
  173. package/resources.d.ts.map +1 -0
  174. package/resources.js +18 -0
  175. package/resources.js.map +1 -0
  176. package/resources.mjs +2 -0
  177. package/resources.mjs.map +1 -0
  178. package/src/_shims/index.d.ts +2 -0
  179. package/src/_shims/index.js +5 -1
  180. package/src/_shims/index.mjs +5 -1
  181. package/src/core.ts +44 -16
  182. package/src/index.ts +111 -60
  183. package/src/resource.ts +1 -1
  184. package/src/resources/balance.ts +8 -5
  185. package/src/resources/banks.ts +130 -67
  186. package/src/resources/beneficiary-payouts.ts +78 -0
  187. package/src/resources/capabilities.ts +1 -10
  188. package/src/resources/charges.ts +30 -21
  189. package/src/resources/checkoutsession.ts +1224 -3096
  190. package/src/resources/customers.ts +164 -9
  191. package/src/resources/data/accounts.ts +113 -0
  192. package/src/resources/data/balances.ts +60 -0
  193. package/src/resources/data/consent.ts +110 -0
  194. package/src/resources/data/data.ts +75 -0
  195. package/src/resources/data/index.ts +20 -0
  196. package/src/resources/data/session.ts +1317 -0
  197. package/src/resources/data/transactions.ts +235 -0
  198. package/src/resources/data.ts +3 -0
  199. package/src/resources/deposits.ts +231 -0
  200. package/src/resources/fx.ts +119 -0
  201. package/src/resources/index.ts +33 -28
  202. package/src/resources/mandates.ts +79 -17
  203. package/src/resources/orders.ts +1449 -1075
  204. package/src/resources/payouts.ts +273 -103
  205. package/src/resources/refunds.ts +70 -111
  206. package/src/resources/returns.ts +140 -0
  207. package/src/resources/subaccounts.ts +26 -4
  208. package/src/resources/transactions.ts +234 -0
  209. package/src/resources/webhook/index.ts +16 -0
  210. package/src/resources/{webhooksubscription.ts → webhook/subscription.ts} +164 -112
  211. package/src/resources/webhook/webhook.ts +69 -0
  212. package/src/resources/webhook.ts +3 -0
  213. package/src/resources.ts +1 -0
  214. package/src/version.ts +1 -1
  215. package/version.d.ts +1 -1
  216. package/version.d.ts.map +1 -1
  217. package/version.js +1 -1
  218. package/version.js.map +1 -1
  219. package/version.mjs +1 -1
  220. package/version.mjs.map +1 -1
  221. package/resources/reports.d.ts +0 -120
  222. package/resources/reports.d.ts.map +0 -1
  223. package/resources/reports.js +0 -31
  224. package/resources/reports.js.map +0 -1
  225. package/resources/reports.mjs +0 -27
  226. package/resources/reports.mjs.map +0 -1
  227. package/resources/webhooksubscription.d.ts +0 -155
  228. package/resources/webhooksubscription.d.ts.map +0 -1
  229. package/resources/webhooksubscription.js.map +0 -1
  230. package/resources/webhooksubscription.mjs.map +0 -1
  231. package/src/resources/reports.ts +0 -172
@@ -0,0 +1,235 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import * as Core from '../../core';
5
+
6
+ export class Transactions extends APIResource {
7
+ /**
8
+ * Retrieves the list of transactions for a given data session. Returns
9
+ * transactions from the last 3 months.
10
+ */
11
+ list(body: TransactionListParams, options?: Core.RequestOptions): Core.APIPromise<TransactionListResponse> {
12
+ return this._client.post('/api/service/data/transactions/list', { body, ...options });
13
+ }
14
+ }
15
+
16
+ export interface TransactionListResponse {
17
+ /**
18
+ * Array of transactions
19
+ */
20
+ data: Array<TransactionListResponse.Data>;
21
+
22
+ /**
23
+ * Pagination information
24
+ */
25
+ paging: TransactionListResponse.Paging;
26
+ }
27
+
28
+ export namespace TransactionListResponse {
29
+ export interface Data {
30
+ /**
31
+ * Transaction identifier
32
+ */
33
+ id: string;
34
+
35
+ /**
36
+ * Amount of the transaction
37
+ */
38
+ amount: string;
39
+
40
+ /**
41
+ * Balance information
42
+ */
43
+ balance: Data.Balance;
44
+
45
+ /**
46
+ * Bank statement reference
47
+ */
48
+ bankStatementReference: string;
49
+
50
+ /**
51
+ * Creditor account details
52
+ */
53
+ creditor: Data.Creditor;
54
+
55
+ /**
56
+ * ISO 4217 currency code
57
+ */
58
+ currency: string;
59
+
60
+ /**
61
+ * Debtor account details
62
+ */
63
+ debtor: Data.Debtor;
64
+
65
+ /**
66
+ * Side of the transaction
67
+ */
68
+ side: 'credit' | 'debit';
69
+
70
+ /**
71
+ * Transaction date as unix timestamp
72
+ */
73
+ transactionDate: number;
74
+ }
75
+
76
+ export namespace Data {
77
+ /**
78
+ * Balance information
79
+ */
80
+ export interface Balance {
81
+ /**
82
+ * Balance after the transaction
83
+ */
84
+ after: string;
85
+
86
+ /**
87
+ * Balance before the transaction
88
+ */
89
+ before: string;
90
+ }
91
+
92
+ /**
93
+ * Creditor account details
94
+ */
95
+ export interface Creditor {
96
+ /**
97
+ * Type of financial address
98
+ */
99
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
100
+
101
+ bankCode?: Creditor.BankCode;
102
+
103
+ bban?: Creditor.Bban;
104
+
105
+ iban?: Creditor.Iban;
106
+
107
+ sortCode?: Creditor.SortCode;
108
+ }
109
+
110
+ export namespace Creditor {
111
+ export interface BankCode {
112
+ accountHolderName: string;
113
+
114
+ accountNumber: string;
115
+
116
+ code: string;
117
+ }
118
+
119
+ export interface Bban {
120
+ accountHolderName: string;
121
+
122
+ bban: string;
123
+
124
+ bic?: string;
125
+ }
126
+
127
+ export interface Iban {
128
+ accountHolderName: string;
129
+
130
+ iban: string;
131
+
132
+ bic?: string;
133
+ }
134
+
135
+ export interface SortCode {
136
+ accountHolderName: string;
137
+
138
+ accountNumber: string;
139
+
140
+ sortCode: string;
141
+ }
142
+ }
143
+
144
+ /**
145
+ * Debtor account details
146
+ */
147
+ export interface Debtor {
148
+ /**
149
+ * Type of financial address
150
+ */
151
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
152
+
153
+ bankCode?: Debtor.BankCode;
154
+
155
+ bban?: Debtor.Bban;
156
+
157
+ iban?: Debtor.Iban;
158
+
159
+ sortCode?: Debtor.SortCode;
160
+ }
161
+
162
+ export namespace Debtor {
163
+ export interface BankCode {
164
+ accountHolderName: string;
165
+
166
+ accountNumber: string;
167
+
168
+ code: string;
169
+ }
170
+
171
+ export interface Bban {
172
+ accountHolderName: string;
173
+
174
+ bban: string;
175
+
176
+ bic?: string;
177
+ }
178
+
179
+ export interface Iban {
180
+ accountHolderName: string;
181
+
182
+ iban: string;
183
+
184
+ bic?: string;
185
+ }
186
+
187
+ export interface SortCode {
188
+ accountHolderName: string;
189
+
190
+ accountNumber: string;
191
+
192
+ sortCode: string;
193
+ }
194
+ }
195
+ }
196
+
197
+ /**
198
+ * Pagination information
199
+ */
200
+ export interface Paging {
201
+ /**
202
+ * Whether there are more transactions available
203
+ */
204
+ hasNext: boolean;
205
+
206
+ /**
207
+ * Cursor for the next page of results
208
+ */
209
+ nextCursor?: string;
210
+ }
211
+ }
212
+
213
+ export interface TransactionListParams {
214
+ /**
215
+ * Start timestamp (inclusive) - unix timestamp
216
+ */
217
+ from: number;
218
+
219
+ /**
220
+ * End timestamp (exclusive) - unix timestamp
221
+ */
222
+ to: number;
223
+
224
+ /**
225
+ * Cursor for pagination
226
+ */
227
+ afterCursor?: string;
228
+ }
229
+
230
+ export declare namespace Transactions {
231
+ export {
232
+ type TransactionListResponse as TransactionListResponse,
233
+ type TransactionListParams as TransactionListParams,
234
+ };
235
+ }
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export * from './data/index';
@@ -0,0 +1,231 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../resource';
4
+ import * as Core from '../core';
5
+
6
+ export class Deposits extends APIResource {
7
+ /**
8
+ * Retrieves a deposit by its ID.
9
+ */
10
+ retrieve(
11
+ body: DepositRetrieveParams,
12
+ options?: Core.RequestOptions,
13
+ ): Core.APIPromise<DepositRetrieveResponse> {
14
+ return this._client.post('/api/service/deposit/retrieve', { body, ...options });
15
+ }
16
+ }
17
+
18
+ export interface DepositRetrieveResponse {
19
+ /**
20
+ * The ID of the deposit
21
+ */
22
+ id: string;
23
+
24
+ /**
25
+ * The amount of the deposit
26
+ */
27
+ amount: number;
28
+
29
+ /**
30
+ * The currency of the deposit
31
+ */
32
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
33
+
34
+ /**
35
+ * The payee account identifier
36
+ */
37
+ payee: DepositRetrieveResponse.Payee;
38
+
39
+ /**
40
+ * The payer account identifier
41
+ */
42
+ payer: DepositRetrieveResponse.Payer;
43
+
44
+ /**
45
+ * The date and time the deposit was received
46
+ */
47
+ receivedAt: string;
48
+
49
+ returns: Array<DepositRetrieveResponse.Return>;
50
+
51
+ /**
52
+ * The status of the deposit
53
+ */
54
+ status: 'received';
55
+
56
+ /**
57
+ * The ID of the transaction that initiated the deposit
58
+ */
59
+ transactionId: string;
60
+
61
+ /**
62
+ * The reference that appears on the bank statement
63
+ */
64
+ bankStatementReference?: string;
65
+
66
+ /**
67
+ * The payment rail used for the deposit
68
+ */
69
+ rail?: string;
70
+ }
71
+
72
+ export namespace DepositRetrieveResponse {
73
+ /**
74
+ * The payee account identifier
75
+ */
76
+ export interface Payee {
77
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
78
+
79
+ bankCode?: Payee.BankCode;
80
+
81
+ bban?: Payee.Bban;
82
+
83
+ iban?: Payee.Iban;
84
+
85
+ sortCode?: Payee.SortCode;
86
+ }
87
+
88
+ export namespace Payee {
89
+ export interface BankCode {
90
+ accountHolderName: string;
91
+
92
+ accountNumber: string;
93
+
94
+ code: string;
95
+ }
96
+
97
+ export interface Bban {
98
+ accountHolderName: string;
99
+
100
+ bban: string;
101
+
102
+ bic?: string;
103
+ }
104
+
105
+ export interface Iban {
106
+ accountHolderName: string;
107
+
108
+ iban: string;
109
+
110
+ bic?: string;
111
+ }
112
+
113
+ export interface SortCode {
114
+ accountHolderName: string;
115
+
116
+ accountNumber: string;
117
+
118
+ sortCode: string;
119
+ }
120
+ }
121
+
122
+ /**
123
+ * The payer account identifier
124
+ */
125
+ export interface Payer {
126
+ type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
127
+
128
+ bankCode?: Payer.BankCode;
129
+
130
+ bban?: Payer.Bban;
131
+
132
+ iban?: Payer.Iban;
133
+
134
+ sortCode?: Payer.SortCode;
135
+ }
136
+
137
+ export namespace Payer {
138
+ export interface BankCode {
139
+ accountHolderName: string;
140
+
141
+ accountNumber: string;
142
+
143
+ code: string;
144
+ }
145
+
146
+ export interface Bban {
147
+ accountHolderName: string;
148
+
149
+ bban: string;
150
+
151
+ bic?: string;
152
+ }
153
+
154
+ export interface Iban {
155
+ accountHolderName: string;
156
+
157
+ iban: string;
158
+
159
+ bic?: string;
160
+ }
161
+
162
+ export interface SortCode {
163
+ accountHolderName: string;
164
+
165
+ accountNumber: string;
166
+
167
+ sortCode: string;
168
+ }
169
+ }
170
+
171
+ export interface Return {
172
+ /**
173
+ * The ID of the return
174
+ */
175
+ id: string;
176
+
177
+ /**
178
+ * The amount of the return
179
+ */
180
+ amount: number;
181
+
182
+ /**
183
+ * The date and time the return was created
184
+ */
185
+ createdAt: string;
186
+
187
+ /**
188
+ * The currency of the return
189
+ */
190
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
191
+
192
+ /**
193
+ * The ID of the associated deposit
194
+ */
195
+ depositId: string;
196
+
197
+ /**
198
+ * The status of the return
199
+ */
200
+ status: 'initiated' | 'succeeded' | 'failed' | 'returned';
201
+
202
+ /**
203
+ * The date and time the return failed if applicable
204
+ */
205
+ failedAt?: string;
206
+
207
+ /**
208
+ * The date and time the return succeeded if applicable
209
+ */
210
+ succeededAt?: string;
211
+
212
+ /**
213
+ * The ID of the resulting return transaction
214
+ */
215
+ transactionId?: string;
216
+ }
217
+ }
218
+
219
+ export interface DepositRetrieveParams {
220
+ /**
221
+ * The ID of the deposit
222
+ */
223
+ id: string;
224
+ }
225
+
226
+ export declare namespace Deposits {
227
+ export {
228
+ type DepositRetrieveResponse as DepositRetrieveResponse,
229
+ type DepositRetrieveParams as DepositRetrieveParams,
230
+ };
231
+ }
@@ -0,0 +1,119 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../resource';
4
+ import * as Core from '../core';
5
+
6
+ export class Fx extends APIResource {
7
+ /**
8
+ * Retrieve the details of a past fx transfer using the fxId.
9
+ */
10
+ retrieve(body: FxRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<FxRetrieveResponse> {
11
+ return this._client.post('/api/service/fx/retrieve', { body, ...options });
12
+ }
13
+
14
+ /**
15
+ * Retrieve the current exchange rate for a given currency pair. The rate is not
16
+ * guaranteed for any following transactions.
17
+ */
18
+ retrieveRate(
19
+ body: FxRetrieveRateParams,
20
+ options?: Core.RequestOptions,
21
+ ): Core.APIPromise<FxRetrieveRateResponse> {
22
+ return this._client.post('/api/service/fx/retrieve-rate', { body, ...options });
23
+ }
24
+ }
25
+
26
+ export interface FxRetrieveResponse {
27
+ /**
28
+ * The fxId attached to the transfer.
29
+ */
30
+ id: string;
31
+
32
+ /**
33
+ * The exchange rate for the given currency pair.
34
+ */
35
+ rate: string;
36
+
37
+ /**
38
+ * The source currency code
39
+ */
40
+ sourceCurrency: 'EUR' | 'GBP';
41
+
42
+ /**
43
+ * The status of the FX transaction.
44
+ */
45
+ status: 'success' | 'processing' | 'failed';
46
+
47
+ /**
48
+ * The target currency code
49
+ */
50
+ targetCurrency: 'USDC';
51
+
52
+ /**
53
+ * Additional metadata.
54
+ */
55
+ metadata?: { [key: string]: unknown };
56
+
57
+ /**
58
+ * The amount of source currency to convert.
59
+ */
60
+ sourceAmount?: string;
61
+
62
+ /**
63
+ * The amount of the target currency for the given source amount.
64
+ */
65
+ targetAmount?: string;
66
+ }
67
+
68
+ export interface FxRetrieveRateResponse {
69
+ /**
70
+ * The current exchange rate for the given currency pair.
71
+ */
72
+ rate: string;
73
+
74
+ /**
75
+ * The amount of source currency to convert. Only returned if the source amount is
76
+ * provided.
77
+ */
78
+ sourceAmount?: string;
79
+
80
+ /**
81
+ * The amount of the target currency for the given source amount. Only returned if
82
+ * the source amount is provided.
83
+ */
84
+ targetAmount?: string;
85
+ }
86
+
87
+ export interface FxRetrieveParams {
88
+ /**
89
+ * The fxId attached to the transfer.
90
+ */
91
+ fxId: string;
92
+ }
93
+
94
+ export interface FxRetrieveRateParams {
95
+ /**
96
+ * The source currency code.
97
+ */
98
+ sourceCurrency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
99
+
100
+ /**
101
+ * The target currency code.
102
+ */
103
+ targetCurrency: 'EUR' | 'GBP' | 'PLN' | 'USDC' | 'SEK' | 'DKK';
104
+
105
+ /**
106
+ * The amount of source currency to convert. If not provided, only the rate will be
107
+ * returned. Decimal places should be separated by a dot.
108
+ */
109
+ sourceAmount?: string;
110
+ }
111
+
112
+ export declare namespace Fx {
113
+ export {
114
+ type FxRetrieveResponse as FxRetrieveResponse,
115
+ type FxRetrieveRateResponse as FxRetrieveRateResponse,
116
+ type FxRetrieveParams as FxRetrieveParams,
117
+ type FxRetrieveRateParams as FxRetrieveRateParams,
118
+ };
119
+ }
@@ -10,6 +10,7 @@ export {
10
10
  type BankListParams,
11
11
  type BankSearchParams,
12
12
  } from './banks';
13
+ export { BeneficiaryPayouts, type BeneficiaryPayoutCreateResponse } from './beneficiary-payouts';
13
14
  export { Capabilities, type CapabilityRetrieveResponse, type CapabilityRetrieveParams } from './capabilities';
14
15
  export { Charges, type Charge, type ChargeCreateParams } from './charges';
15
16
  export {
@@ -25,12 +26,24 @@ export {
25
26
  Customers,
26
27
  type CustomerCreateResponse,
27
28
  type CustomerRetrieveResponse,
29
+ type CustomerSearchResponse,
28
30
  type CustomerCreateParams,
29
31
  type CustomerRetrieveParams,
32
+ type CustomerSearchParams,
30
33
  } from './customers';
34
+ export { Data } from './data/data';
35
+ export { Deposits, type DepositRetrieveResponse, type DepositRetrieveParams } from './deposits';
36
+ export {
37
+ Fx,
38
+ type FxRetrieveResponse,
39
+ type FxRetrieveRateResponse,
40
+ type FxRetrieveParams,
41
+ type FxRetrieveRateParams,
42
+ } from './fx';
31
43
  export {
32
44
  Mandates,
33
- type MandateResponse,
45
+ type Mandate,
46
+ type MandateLookupResponse,
34
47
  type MandateRevokeResponse,
35
48
  type MandateRetrieveParams,
36
49
  type MandateLookupParams,
@@ -38,14 +51,17 @@ export {
38
51
  } from './mandates';
39
52
  export {
40
53
  Orders,
54
+ type OrderCreateResponse,
41
55
  type OrderRetrieveResponse,
42
- type OrderUpdateResponse,
56
+ type OrderExpireResponse,
57
+ type OrderCreateParams,
43
58
  type OrderRetrieveParams,
44
- type OrderUpdateParams,
59
+ type OrderExpireParams,
45
60
  } from './orders';
46
61
  export {
47
62
  Payouts,
48
- type PublicUserPayout,
63
+ type Payout,
64
+ type PayoutRetrieveResponse,
49
65
  type PayoutListResponse,
50
66
  type PayoutCreateParams,
51
67
  type PayoutRetrieveParams,
@@ -53,36 +69,25 @@ export {
53
69
  } from './payouts';
54
70
  export {
55
71
  Refunds,
56
- type RefundResponse,
57
- type RefundBatchResponse,
72
+ type Refund,
73
+ type RefundCreateResponse,
74
+ type RefundRetrieveResponse,
58
75
  type RefundCreateParams,
59
- type RefundBatchParams,
76
+ type RefundRetrieveParams,
60
77
  } from './refunds';
61
78
  export {
62
- Reports,
63
- type PayoutReport,
64
- type ReportCreateResponse,
65
- type ReportRetrieveResponse,
66
- type ReportCreateParams,
67
- type ReportRetrieveParams,
68
- type ReportDownloadParams,
69
- } from './reports';
79
+ Returns,
80
+ type ReturnCreateResponse,
81
+ type ReturnRetrieveResponse,
82
+ type ReturnCreateParams,
83
+ type ReturnRetrieveParams,
84
+ } from './returns';
70
85
  export {
71
86
  Subaccounts,
72
87
  type Subaccount,
88
+ type SubaccountCreateResponse,
73
89
  type SubaccountCreateParams,
74
90
  type SubaccountRetrieveParams,
75
91
  } from './subaccounts';
76
- export {
77
- Webhooksubscription,
78
- type WebhooksubscriptionCreateResponse,
79
- type WebhooksubscriptionUpdateResponse,
80
- type WebhooksubscriptionListResponse,
81
- type WebhooksubscriptionDeleteResponse,
82
- type WebhooksubscriptionPingResponse,
83
- type WebhooksubscriptionCreateParams,
84
- type WebhooksubscriptionUpdateParams,
85
- type WebhooksubscriptionListParams,
86
- type WebhooksubscriptionDeleteParams,
87
- type WebhooksubscriptionPingParams,
88
- } from './webhooksubscription';
92
+ export { Transactions, type TransactionListResponse, type TransactionListParams } from './transactions';
93
+ export { Webhook, type WebhookTriggerResponse, type WebhookTriggerParams } from './webhook/webhook';