@moovio/sdk 0.21.0 → 0.21.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.
Files changed (71) hide show
  1. package/bin/mcp-server.js +79 -61
  2. package/bin/mcp-server.js.map +11 -10
  3. package/examples/package-lock.json +1 -1
  4. package/hooks/hooks.d.ts +3 -2
  5. package/hooks/hooks.d.ts.map +1 -1
  6. package/hooks/hooks.js.map +1 -1
  7. package/hooks/moov-version-hook.d.ts +6 -0
  8. package/hooks/moov-version-hook.d.ts.map +1 -0
  9. package/hooks/moov-version-hook.js +12 -0
  10. package/hooks/moov-version-hook.js.map +1 -0
  11. package/hooks/registration.d.ts.map +1 -1
  12. package/hooks/registration.js +3 -1
  13. package/hooks/registration.js.map +1 -1
  14. package/hooks/types.d.ts +2 -6
  15. package/hooks/types.d.ts.map +1 -1
  16. package/jsr.json +1 -1
  17. package/lib/config.d.ts +3 -3
  18. package/lib/config.js +3 -3
  19. package/lib/sdks.d.ts.map +1 -1
  20. package/lib/sdks.js +5 -6
  21. package/lib/sdks.js.map +1 -1
  22. package/mcp-server/mcp-server.js +1 -1
  23. package/mcp-server/server.js +1 -1
  24. package/package.json +1 -1
  25. package/src/hooks/hooks.ts +2 -2
  26. package/src/hooks/moov-version-hook.ts +9 -0
  27. package/src/hooks/registration.ts +4 -1
  28. package/src/hooks/types.ts +2 -7
  29. package/src/lib/config.ts +3 -3
  30. package/src/lib/sdks.ts +6 -7
  31. package/src/mcp-server/mcp-server.ts +1 -1
  32. package/src/mcp-server/server.ts +1 -1
  33. package/docs/sdks/accounts/README.md +0 -1038
  34. package/docs/sdks/accountterminalapplications/README.md +0 -371
  35. package/docs/sdks/adjustments/README.md +0 -185
  36. package/docs/sdks/applepay/README.md +0 -572
  37. package/docs/sdks/authentication/README.md +0 -191
  38. package/docs/sdks/avatars/README.md +0 -95
  39. package/docs/sdks/bankaccounts/README.md +0 -951
  40. package/docs/sdks/branding/README.md +0 -407
  41. package/docs/sdks/capabilities/README.md +0 -380
  42. package/docs/sdks/cardissuing/README.md +0 -533
  43. package/docs/sdks/cards/README.md +0 -544
  44. package/docs/sdks/disputes/README.md +0 -1085
  45. package/docs/sdks/endtoendencryption/README.md +0 -174
  46. package/docs/sdks/enrichedaddress/README.md +0 -95
  47. package/docs/sdks/enrichedprofile/README.md +0 -95
  48. package/docs/sdks/feeplans/README.md +0 -921
  49. package/docs/sdks/files/README.md +0 -293
  50. package/docs/sdks/images/README.md +0 -616
  51. package/docs/sdks/industries/README.md +0 -91
  52. package/docs/sdks/institutions/README.md +0 -184
  53. package/docs/sdks/issuingtransactions/README.md +0 -465
  54. package/docs/sdks/onboarding/README.md +0 -389
  55. package/docs/sdks/paymentlinks/README.md +0 -615
  56. package/docs/sdks/paymentmethods/README.md +0 -187
  57. package/docs/sdks/ping/README.md +0 -91
  58. package/docs/sdks/products/README.md +0 -616
  59. package/docs/sdks/receipts/README.md +0 -180
  60. package/docs/sdks/representatives/README.md +0 -603
  61. package/docs/sdks/scheduling/README.md +0 -1018
  62. package/docs/sdks/statements/README.md +0 -194
  63. package/docs/sdks/support/README.md +0 -505
  64. package/docs/sdks/sweeps/README.md +0 -571
  65. package/docs/sdks/terminalapplications/README.md +0 -460
  66. package/docs/sdks/transfers/README.md +0 -1136
  67. package/docs/sdks/underwriting/README.md +0 -331
  68. package/docs/sdks/wallets/README.md +0 -416
  69. package/docs/sdks/wallettransactions/README.md +0 -202
  70. package/examples/README.md +0 -31
  71. package/test/README.md +0 -14
package/docs/sdks/wallets/README.md DELETED
@@ -1,416 +0,0 @@
1
- # Wallets
2
- (*wallets*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create a new wallet for an account. You can specify optional attributes such as a display name and description to specify the intended use of the wallet. This will generate a new moov-wallet payment method.
9
-
10
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
11
-
12
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
13
- you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
14
- * [list](#list) - List the wallets associated with a Moov account.
15
-
16
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
17
-
18
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
19
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
20
- * [get](#get) - Get information on a specific wallet (e.g., the available balance).
21
-
22
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
23
-
24
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
25
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
26
- * [update](#update) - Update properties of an existing wallet such as name, description, status, or metadata.
27
-
28
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
29
-
30
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
31
- you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
32
-
33
- ## create
34
-
35
- Create a new wallet for an account. You can specify optional attributes such as a display name and description to specify the intended use of the wallet. This will generate a new moov-wallet payment method.
36
-
37
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
38
-
39
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
40
- you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
41
-
42
- ### Example Usage
43
-
44
- <!-- UsageSnippet language="typescript" operationID="createWallet" method="post" path="/accounts/{accountID}/wallets" -->
45
- ```typescript
46
- import { Moov } from "@moovio/sdk";
47
-
48
- const moov = new Moov({
49
- xMoovVersion: "v2024.01.00",
50
- security: {
51
- username: "",
52
- password: "",
53
- },
54
- });
55
-
56
- async function run() {
57
- const result = await moov.wallets.create({
58
- accountID: "b4b3f37c-b73e-4271-b8ec-108a8593c9b9",
59
- createWallet: {
60
- name: "My wallet",
61
- description: "A general wallet used for my payments",
62
- metadata: {
63
- "optional": "metadata",
64
- },
65
- },
66
- });
67
-
68
- console.log(result);
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Standalone function
75
-
76
- The standalone function version of this method:
77
-
78
- ```typescript
79
- import { MoovCore } from "@moovio/sdk/core.js";
80
- import { walletsCreate } from "@moovio/sdk/funcs/walletsCreate.js";
81
-
82
- // Use `MoovCore` for best tree-shaking performance.
83
- // You can create one instance of it to use across an application.
84
- const moov = new MoovCore({
85
- xMoovVersion: "v2024.01.00",
86
- security: {
87
- username: "",
88
- password: "",
89
- },
90
- });
91
-
92
- async function run() {
93
- const res = await walletsCreate(moov, {
94
- accountID: "b4b3f37c-b73e-4271-b8ec-108a8593c9b9",
95
- createWallet: {
96
- name: "My wallet",
97
- description: "A general wallet used for my payments",
98
- metadata: {
99
- "optional": "metadata",
100
- },
101
- },
102
- });
103
- if (res.ok) {
104
- const { value: result } = res;
105
- console.log(result);
106
- } else {
107
- console.log("walletsCreate failed:", res.error);
108
- }
109
- }
110
-
111
- run();
112
- ```
113
-
114
- ### Parameters
115
-
116
- | Parameter | Type | Required | Description |
117
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
118
- | `request` | [operations.CreateWalletRequest](../../models/operations/createwalletrequest.md) | :heavy_check_mark: | The request object to use for the request. |
119
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
120
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
121
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
122
-
123
- ### Response
124
-
125
- **Promise\<[operations.CreateWalletResponse](../../models/operations/createwalletresponse.md)\>**
126
-
127
- ### Errors
128
-
129
- | Error Type | Status Code | Content Type |
130
- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
131
- | errors.GenericError | 400, 409 | application/json |
132
- | errors.CreateWalletValidationError | 422 | application/json |
133
- | errors.APIError | 4XX, 5XX | \*/\* |
134
-
135
- ## list
136
-
137
- List the wallets associated with a Moov account.
138
-
139
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
140
-
141
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
142
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
143
-
144
- ### Example Usage
145
-
146
- <!-- UsageSnippet language="typescript" operationID="listWallets" method="get" path="/accounts/{accountID}/wallets" -->
147
- ```typescript
148
- import { Moov } from "@moovio/sdk";
149
-
150
- const moov = new Moov({
151
- xMoovVersion: "v2024.01.00",
152
- security: {
153
- username: "",
154
- password: "",
155
- },
156
- });
157
-
158
- async function run() {
159
- const result = await moov.wallets.list({
160
- skip: 60,
161
- count: 20,
162
- accountID: "25221c3c-8e3f-40db-8570-66d17b51014d",
163
- });
164
-
165
- console.log(result);
166
- }
167
-
168
- run();
169
- ```
170
-
171
- ### Standalone function
172
-
173
- The standalone function version of this method:
174
-
175
- ```typescript
176
- import { MoovCore } from "@moovio/sdk/core.js";
177
- import { walletsList } from "@moovio/sdk/funcs/walletsList.js";
178
-
179
- // Use `MoovCore` for best tree-shaking performance.
180
- // You can create one instance of it to use across an application.
181
- const moov = new MoovCore({
182
- xMoovVersion: "v2024.01.00",
183
- security: {
184
- username: "",
185
- password: "",
186
- },
187
- });
188
-
189
- async function run() {
190
- const res = await walletsList(moov, {
191
- skip: 60,
192
- count: 20,
193
- accountID: "25221c3c-8e3f-40db-8570-66d17b51014d",
194
- });
195
- if (res.ok) {
196
- const { value: result } = res;
197
- console.log(result);
198
- } else {
199
- console.log("walletsList failed:", res.error);
200
- }
201
- }
202
-
203
- run();
204
- ```
205
-
206
- ### Parameters
207
-
208
- | Parameter | Type | Required | Description |
209
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
210
- | `request` | [operations.ListWalletsRequest](../../models/operations/listwalletsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
211
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
212
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
213
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
214
-
215
- ### Response
216
-
217
- **Promise\<[operations.ListWalletsResponse](../../models/operations/listwalletsresponse.md)\>**
218
-
219
- ### Errors
220
-
221
- | Error Type | Status Code | Content Type |
222
- | --------------------------------- | --------------------------------- | --------------------------------- |
223
- | errors.ListWalletsValidationError | 422 | application/json |
224
- | errors.APIError | 4XX, 5XX | \*/\* |
225
-
226
- ## get
227
-
228
- Get information on a specific wallet (e.g., the available balance).
229
-
230
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
231
-
232
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
233
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
234
-
235
- ### Example Usage
236
-
237
- <!-- UsageSnippet language="typescript" operationID="getWallet" method="get" path="/accounts/{accountID}/wallets/{walletID}" -->
238
- ```typescript
239
- import { Moov } from "@moovio/sdk";
240
-
241
- const moov = new Moov({
242
- xMoovVersion: "v2024.01.00",
243
- security: {
244
- username: "",
245
- password: "",
246
- },
247
- });
248
-
249
- async function run() {
250
- const result = await moov.wallets.get({
251
- accountID: "d04dfd44-8194-422f-a666-08d30c183f9a",
252
- walletID: "10a6bc37-8eeb-41c8-bf5f-77b40955542a",
253
- });
254
-
255
- console.log(result);
256
- }
257
-
258
- run();
259
- ```
260
-
261
- ### Standalone function
262
-
263
- The standalone function version of this method:
264
-
265
- ```typescript
266
- import { MoovCore } from "@moovio/sdk/core.js";
267
- import { walletsGet } from "@moovio/sdk/funcs/walletsGet.js";
268
-
269
- // Use `MoovCore` for best tree-shaking performance.
270
- // You can create one instance of it to use across an application.
271
- const moov = new MoovCore({
272
- xMoovVersion: "v2024.01.00",
273
- security: {
274
- username: "",
275
- password: "",
276
- },
277
- });
278
-
279
- async function run() {
280
- const res = await walletsGet(moov, {
281
- accountID: "d04dfd44-8194-422f-a666-08d30c183f9a",
282
- walletID: "10a6bc37-8eeb-41c8-bf5f-77b40955542a",
283
- });
284
- if (res.ok) {
285
- const { value: result } = res;
286
- console.log(result);
287
- } else {
288
- console.log("walletsGet failed:", res.error);
289
- }
290
- }
291
-
292
- run();
293
- ```
294
-
295
- ### Parameters
296
-
297
- | Parameter | Type | Required | Description |
298
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
299
- | `request` | [operations.GetWalletRequest](../../models/operations/getwalletrequest.md) | :heavy_check_mark: | The request object to use for the request. |
300
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
301
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
302
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
303
-
304
- ### Response
305
-
306
- **Promise\<[operations.GetWalletResponse](../../models/operations/getwalletresponse.md)\>**
307
-
308
- ### Errors
309
-
310
- | Error Type | Status Code | Content Type |
311
- | --------------- | --------------- | --------------- |
312
- | errors.APIError | 4XX, 5XX | \*/\* |
313
-
314
- ## update
315
-
316
- Update properties of an existing wallet such as name, description, status, or metadata.
317
-
318
- Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.
319
-
320
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
321
- you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
322
-
323
- ### Example Usage
324
-
325
- <!-- UsageSnippet language="typescript" operationID="updateWallet" method="patch" path="/accounts/{accountID}/wallets/{walletID}" -->
326
- ```typescript
327
- import { Moov } from "@moovio/sdk";
328
-
329
- const moov = new Moov({
330
- xMoovVersion: "v2024.01.00",
331
- security: {
332
- username: "",
333
- password: "",
334
- },
335
- });
336
-
337
- async function run() {
338
- const result = await moov.wallets.update({
339
- walletID: "9f1c6e07-aae8-40e6-b290-502bb1bc486e",
340
- accountID: "e4aad2fb-201d-4390-b4d3-6de7716152e1",
341
- patchWallet: {
342
- name: "My second wallet",
343
- description: "My new description",
344
- metadata: {
345
- "optional": "metadata",
346
- },
347
- },
348
- });
349
-
350
- console.log(result);
351
- }
352
-
353
- run();
354
- ```
355
-
356
- ### Standalone function
357
-
358
- The standalone function version of this method:
359
-
360
- ```typescript
361
- import { MoovCore } from "@moovio/sdk/core.js";
362
- import { walletsUpdate } from "@moovio/sdk/funcs/walletsUpdate.js";
363
-
364
- // Use `MoovCore` for best tree-shaking performance.
365
- // You can create one instance of it to use across an application.
366
- const moov = new MoovCore({
367
- xMoovVersion: "v2024.01.00",
368
- security: {
369
- username: "",
370
- password: "",
371
- },
372
- });
373
-
374
- async function run() {
375
- const res = await walletsUpdate(moov, {
376
- walletID: "9f1c6e07-aae8-40e6-b290-502bb1bc486e",
377
- accountID: "e4aad2fb-201d-4390-b4d3-6de7716152e1",
378
- patchWallet: {
379
- name: "My second wallet",
380
- description: "My new description",
381
- metadata: {
382
- "optional": "metadata",
383
- },
384
- },
385
- });
386
- if (res.ok) {
387
- const { value: result } = res;
388
- console.log(result);
389
- } else {
390
- console.log("walletsUpdate failed:", res.error);
391
- }
392
- }
393
-
394
- run();
395
- ```
396
-
397
- ### Parameters
398
-
399
- | Parameter | Type | Required | Description |
400
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
401
- | `request` | [operations.UpdateWalletRequest](../../models/operations/updatewalletrequest.md) | :heavy_check_mark: | The request object to use for the request. |
402
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
403
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
404
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
405
-
406
- ### Response
407
-
408
- **Promise\<[operations.UpdateWalletResponse](../../models/operations/updatewalletresponse.md)\>**
409
-
410
- ### Errors
411
-
412
- | Error Type | Status Code | Content Type |
413
- | --------------------------------- | --------------------------------- | --------------------------------- |
414
- | errors.GenericError | 400, 409 | application/json |
415
- | errors.PatchWalletValidationError | 422 | application/json |
416
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/wallettransactions/README.md DELETED
@@ -1,202 +0,0 @@
1
- # WalletTransactions
2
- (*walletTransactions*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List all the transactions associated with a particular Moov wallet.
9
-
10
- Read our [wallet transactions guide](https://docs.moov.io/guides/sources/wallets/transactions/) to learn more.
11
-
12
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
13
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
14
- * [get](#get) - Get details on a specific wallet transaction.
15
-
16
- Read our [wallet transactions guide](https://docs.moov.io/guides/sources/wallets/transactions/) to learn more.
17
-
18
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
19
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
20
-
21
- ## list
22
-
23
- List all the transactions associated with a particular Moov wallet.
24
-
25
- Read our [wallet transactions guide](https://docs.moov.io/guides/sources/wallets/transactions/) to learn more.
26
-
27
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
28
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
29
-
30
- ### Example Usage
31
-
32
- <!-- UsageSnippet language="typescript" operationID="listWalletTransactions" method="get" path="/accounts/{accountID}/wallets/{walletID}/transactions" -->
33
- ```typescript
34
- import { Moov } from "@moovio/sdk";
35
-
36
- const moov = new Moov({
37
- xMoovVersion: "v2024.01.00",
38
- security: {
39
- username: "",
40
- password: "",
41
- },
42
- });
43
-
44
- async function run() {
45
- const result = await moov.walletTransactions.list({
46
- accountID: "69e4529b-baf0-4f00-877b-123cfd9d6116",
47
- skip: 60,
48
- count: 20,
49
- walletID: "4f971587-62fe-42c9-bc61-7409d9c8660c",
50
- });
51
-
52
- console.log(result);
53
- }
54
-
55
- run();
56
- ```
57
-
58
- ### Standalone function
59
-
60
- The standalone function version of this method:
61
-
62
- ```typescript
63
- import { MoovCore } from "@moovio/sdk/core.js";
64
- import { walletTransactionsList } from "@moovio/sdk/funcs/walletTransactionsList.js";
65
-
66
- // Use `MoovCore` for best tree-shaking performance.
67
- // You can create one instance of it to use across an application.
68
- const moov = new MoovCore({
69
- xMoovVersion: "v2024.01.00",
70
- security: {
71
- username: "",
72
- password: "",
73
- },
74
- });
75
-
76
- async function run() {
77
- const res = await walletTransactionsList(moov, {
78
- accountID: "69e4529b-baf0-4f00-877b-123cfd9d6116",
79
- skip: 60,
80
- count: 20,
81
- walletID: "4f971587-62fe-42c9-bc61-7409d9c8660c",
82
- });
83
- if (res.ok) {
84
- const { value: result } = res;
85
- console.log(result);
86
- } else {
87
- console.log("walletTransactionsList failed:", res.error);
88
- }
89
- }
90
-
91
- run();
92
- ```
93
-
94
- ### Parameters
95
-
96
- | Parameter | Type | Required | Description |
97
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
98
- | `request` | [operations.ListWalletTransactionsRequest](../../models/operations/listwallettransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
99
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
100
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
101
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
102
-
103
- ### Response
104
-
105
- **Promise\<[operations.ListWalletTransactionsResponse](../../models/operations/listwallettransactionsresponse.md)\>**
106
-
107
- ### Errors
108
-
109
- | Error Type | Status Code | Content Type |
110
- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
111
- | errors.ListWalletTransactionsValidationError | 422 | application/json |
112
- | errors.APIError | 4XX, 5XX | \*/\* |
113
-
114
- ## get
115
-
116
- Get details on a specific wallet transaction.
117
-
118
- Read our [wallet transactions guide](https://docs.moov.io/guides/sources/wallets/transactions/) to learn more.
119
-
120
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
121
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
122
-
123
- ### Example Usage
124
-
125
- <!-- UsageSnippet language="typescript" operationID="getWalletTransaction" method="get" path="/accounts/{accountID}/wallets/{walletID}/transactions/{transactionID}" -->
126
- ```typescript
127
- import { Moov } from "@moovio/sdk";
128
-
129
- const moov = new Moov({
130
- xMoovVersion: "v2024.01.00",
131
- security: {
132
- username: "",
133
- password: "",
134
- },
135
- });
136
-
137
- async function run() {
138
- const result = await moov.walletTransactions.get({
139
- accountID: "f0b02d73-10dc-42e6-8030-fd78fcbc114f",
140
- walletID: "03db97f6-c308-4595-8f43-fd247f1bd3f2",
141
- transactionID: "e0a32cf5-5758-49ba-83da-75bf02c9c6d7",
142
- });
143
-
144
- console.log(result);
145
- }
146
-
147
- run();
148
- ```
149
-
150
- ### Standalone function
151
-
152
- The standalone function version of this method:
153
-
154
- ```typescript
155
- import { MoovCore } from "@moovio/sdk/core.js";
156
- import { walletTransactionsGet } from "@moovio/sdk/funcs/walletTransactionsGet.js";
157
-
158
- // Use `MoovCore` for best tree-shaking performance.
159
- // You can create one instance of it to use across an application.
160
- const moov = new MoovCore({
161
- xMoovVersion: "v2024.01.00",
162
- security: {
163
- username: "",
164
- password: "",
165
- },
166
- });
167
-
168
- async function run() {
169
- const res = await walletTransactionsGet(moov, {
170
- accountID: "f0b02d73-10dc-42e6-8030-fd78fcbc114f",
171
- walletID: "03db97f6-c308-4595-8f43-fd247f1bd3f2",
172
- transactionID: "e0a32cf5-5758-49ba-83da-75bf02c9c6d7",
173
- });
174
- if (res.ok) {
175
- const { value: result } = res;
176
- console.log(result);
177
- } else {
178
- console.log("walletTransactionsGet failed:", res.error);
179
- }
180
- }
181
-
182
- run();
183
- ```
184
-
185
- ### Parameters
186
-
187
- | Parameter | Type | Required | Description |
188
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
189
- | `request` | [operations.GetWalletTransactionRequest](../../models/operations/getwallettransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
190
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
191
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
192
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
193
-
194
- ### Response
195
-
196
- **Promise\<[operations.GetWalletTransactionResponse](../../models/operations/getwallettransactionresponse.md)\>**
197
-
198
- ### Errors
199
-
200
- | Error Type | Status Code | Content Type |
201
- | --------------- | --------------- | --------------- |
202
- | errors.APIError | 4XX, 5XX | \*/\* |