@moovio/sdk 0.12.0 → 0.12.1

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 (118) hide show
  1. package/FUNCTIONS.md +6 -22
  2. package/README.md +97 -55
  3. package/bin/mcp-server.js +749 -415
  4. package/bin/mcp-server.js.map +19 -9
  5. package/docs/sdks/accounts/README.md +63 -81
  6. package/docs/sdks/accountterminalapplications/README.md +28 -36
  7. package/docs/sdks/adjustments/README.md +14 -18
  8. package/docs/sdks/applepay/README.md +35 -45
  9. package/docs/sdks/authentication/README.md +14 -18
  10. package/docs/sdks/avatars/README.md +7 -9
  11. package/docs/sdks/bankaccounts/README.md +63 -81
  12. package/docs/sdks/branding/README.md +28 -36
  13. package/docs/sdks/capabilities/README.md +28 -36
  14. package/docs/sdks/cardissuing/README.md +35 -45
  15. package/docs/sdks/cards/README.md +35 -45
  16. package/docs/sdks/disputes/README.md +77 -99
  17. package/docs/sdks/endtoendencryption/README.md +14 -18
  18. package/docs/sdks/enrichedaddress/README.md +7 -9
  19. package/docs/sdks/enrichedprofile/README.md +7 -9
  20. package/docs/sdks/feeplans/README.md +49 -63
  21. package/docs/sdks/files/README.md +21 -27
  22. package/docs/sdks/industries/README.md +7 -9
  23. package/docs/sdks/institutions/README.md +98 -9
  24. package/docs/sdks/issuingtransactions/README.md +35 -45
  25. package/docs/sdks/onboarding/README.md +28 -36
  26. package/docs/sdks/paymentlinks/README.md +42 -54
  27. package/docs/sdks/paymentmethods/README.md +14 -18
  28. package/docs/sdks/ping/README.md +7 -9
  29. package/docs/sdks/receipts/README.md +14 -18
  30. package/docs/sdks/representatives/README.md +35 -45
  31. package/docs/sdks/scheduling/README.md +42 -54
  32. package/docs/sdks/sweeps/README.md +42 -54
  33. package/docs/sdks/terminalapplications/README.md +28 -36
  34. package/docs/sdks/transfers/README.md +77 -99
  35. package/docs/sdks/underwriting/README.md +14 -18
  36. package/docs/sdks/wallets/README.md +14 -18
  37. package/docs/sdks/wallettransactions/README.md +14 -18
  38. package/funcs/institutionsSearchInstitutions.d.ts +20 -0
  39. package/funcs/institutionsSearchInstitutions.d.ts.map +1 -0
  40. package/funcs/institutionsSearchInstitutions.js +129 -0
  41. package/funcs/institutionsSearchInstitutions.js.map +1 -0
  42. package/jsr.json +1 -1
  43. package/lib/config.d.ts +3 -3
  44. package/lib/config.js +3 -3
  45. package/mcp-server/mcp-server.js +1 -1
  46. package/mcp-server/server.d.ts.map +1 -1
  47. package/mcp-server/server.js +3 -1
  48. package/mcp-server/server.js.map +1 -1
  49. package/mcp-server/tools/institutionsSearchInstitutions.d.ts +8 -0
  50. package/mcp-server/tools/institutionsSearchInstitutions.d.ts.map +1 -0
  51. package/mcp-server/tools/institutionsSearchInstitutions.js +69 -0
  52. package/mcp-server/tools/institutionsSearchInstitutions.js.map +1 -0
  53. package/models/components/achinstitution.d.ts +40 -0
  54. package/models/components/achinstitution.d.ts.map +1 -0
  55. package/models/components/achinstitution.js +77 -0
  56. package/models/components/achinstitution.js.map +1 -0
  57. package/models/components/contact.d.ts +30 -0
  58. package/models/components/contact.d.ts.map +1 -0
  59. package/models/components/contact.js +70 -0
  60. package/models/components/contact.js.map +1 -0
  61. package/models/components/index.d.ts +7 -0
  62. package/models/components/index.d.ts.map +1 -1
  63. package/models/components/index.js +7 -0
  64. package/models/components/index.js.map +1 -1
  65. package/models/components/institutionssearchresponse.d.ts +36 -0
  66. package/models/components/institutionssearchresponse.d.ts.map +1 -0
  67. package/models/components/institutionssearchresponse.js +76 -0
  68. package/models/components/institutionssearchresponse.js.map +1 -0
  69. package/models/components/rtpinstitution.d.ts +37 -0
  70. package/models/components/rtpinstitution.d.ts.map +1 -0
  71. package/models/components/rtpinstitution.js +74 -0
  72. package/models/components/rtpinstitution.js.map +1 -0
  73. package/models/components/rtpservices.d.ts +37 -0
  74. package/models/components/rtpservices.d.ts.map +1 -0
  75. package/models/components/rtpservices.js +71 -0
  76. package/models/components/rtpservices.js.map +1 -0
  77. package/models/components/wireinstitution.d.ts +40 -0
  78. package/models/components/wireinstitution.d.ts.map +1 -0
  79. package/models/components/wireinstitution.js +77 -0
  80. package/models/components/wireinstitution.js.map +1 -0
  81. package/models/components/wireservices.d.ts +42 -0
  82. package/models/components/wireservices.d.ts.map +1 -0
  83. package/models/components/wireservices.js +73 -0
  84. package/models/components/wireservices.js.map +1 -0
  85. package/models/errors/apierror.d.ts +14 -2
  86. package/models/errors/apierror.d.ts.map +1 -1
  87. package/models/errors/apierror.js +1 -1
  88. package/models/errors/apierror.js.map +1 -1
  89. package/models/operations/index.d.ts +1 -0
  90. package/models/operations/index.d.ts.map +1 -1
  91. package/models/operations/index.js +1 -0
  92. package/models/operations/index.js.map +1 -1
  93. package/models/operations/searchinstitutions.d.ts +112 -0
  94. package/models/operations/searchinstitutions.d.ts.map +1 -0
  95. package/models/operations/searchinstitutions.js +149 -0
  96. package/models/operations/searchinstitutions.js.map +1 -0
  97. package/package.json +1 -1
  98. package/sdk/institutions.d.ts +11 -0
  99. package/sdk/institutions.d.ts.map +1 -1
  100. package/sdk/institutions.js +14 -0
  101. package/sdk/institutions.js.map +1 -1
  102. package/src/funcs/institutionsSearchInstitutions.ts +179 -0
  103. package/src/lib/config.ts +3 -3
  104. package/src/mcp-server/mcp-server.ts +1 -1
  105. package/src/mcp-server/server.ts +3 -1
  106. package/src/mcp-server/tools/institutionsSearchInstitutions.ts +43 -0
  107. package/src/models/components/achinstitution.ts +89 -0
  108. package/src/models/components/contact.ts +65 -0
  109. package/src/models/components/index.ts +7 -0
  110. package/src/models/components/institutionssearchresponse.ts +92 -0
  111. package/src/models/components/rtpinstitution.ts +79 -0
  112. package/src/models/components/rtpservices.ts +72 -0
  113. package/src/models/components/wireinstitution.ts +91 -0
  114. package/src/models/components/wireservices.ts +79 -0
  115. package/src/models/errors/apierror.ts +18 -3
  116. package/src/models/operations/index.ts +1 -0
  117. package/src/models/operations/searchinstitutions.ts +236 -0
  118. package/src/sdk/institutions.ts +22 -0
@@ -43,6 +43,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
43
43
  import { Moov } from "@moovio/sdk";
44
44
 
45
45
  const moov = new Moov({
46
+ xMoovVersion: "v2024.01.00",
46
47
  security: {
47
48
  username: "",
48
49
  password: "",
@@ -60,7 +61,6 @@ async function run() {
60
61
  },
61
62
  });
62
63
 
63
- // Handle the result
64
64
  console.log(result);
65
65
  }
66
66
 
@@ -78,6 +78,7 @@ import { sweepsCreateConfig } from "@moovio/sdk/funcs/sweepsCreateConfig.js";
78
78
  // Use `MoovCore` for best tree-shaking performance.
79
79
  // You can create one instance of it to use across an application.
80
80
  const moov = new MoovCore({
81
+ xMoovVersion: "v2024.01.00",
81
82
  security: {
82
83
  username: "",
83
84
  password: "",
@@ -94,15 +95,12 @@ async function run() {
94
95
  pullPaymentMethodID: "01234567-89ab-cdef-0123-456789abcdef",
95
96
  },
96
97
  });
97
-
98
- if (!res.ok) {
99
- throw res.error;
98
+ if (res.ok) {
99
+ const { value: result } = res;
100
+ console.log(result);
101
+ } else {
102
+ console.log("sweepsCreateConfig failed:", res.error);
100
103
  }
101
-
102
- const { value: result } = res;
103
-
104
- // Handle the result
105
- console.log(result);
106
104
  }
107
105
 
108
106
  run();
@@ -142,6 +140,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
142
140
  import { Moov } from "@moovio/sdk";
143
141
 
144
142
  const moov = new Moov({
143
+ xMoovVersion: "v2024.01.00",
145
144
  security: {
146
145
  username: "",
147
146
  password: "",
@@ -153,7 +152,6 @@ async function run() {
153
152
  accountID: "ed67e4c8-03d3-4d88-ba38-fcd87de45a92",
154
153
  });
155
154
 
156
- // Handle the result
157
155
  console.log(result);
158
156
  }
159
157
 
@@ -171,6 +169,7 @@ import { sweepsListConfigs } from "@moovio/sdk/funcs/sweepsListConfigs.js";
171
169
  // Use `MoovCore` for best tree-shaking performance.
172
170
  // You can create one instance of it to use across an application.
173
171
  const moov = new MoovCore({
172
+ xMoovVersion: "v2024.01.00",
174
173
  security: {
175
174
  username: "",
176
175
  password: "",
@@ -181,15 +180,12 @@ async function run() {
181
180
  const res = await sweepsListConfigs(moov, {
182
181
  accountID: "ed67e4c8-03d3-4d88-ba38-fcd87de45a92",
183
182
  });
184
-
185
- if (!res.ok) {
186
- throw res.error;
183
+ if (res.ok) {
184
+ const { value: result } = res;
185
+ console.log(result);
186
+ } else {
187
+ console.log("sweepsListConfigs failed:", res.error);
187
188
  }
188
-
189
- const { value: result } = res;
190
-
191
- // Handle the result
192
- console.log(result);
193
189
  }
194
190
 
195
191
  run();
@@ -227,6 +223,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
227
223
  import { Moov } from "@moovio/sdk";
228
224
 
229
225
  const moov = new Moov({
226
+ xMoovVersion: "v2024.01.00",
230
227
  security: {
231
228
  username: "",
232
229
  password: "",
@@ -239,7 +236,6 @@ async function run() {
239
236
  sweepConfigID: "bfddff28-5291-4d9b-a0f8-22a0895e8486",
240
237
  });
241
238
 
242
- // Handle the result
243
239
  console.log(result);
244
240
  }
245
241
 
@@ -257,6 +253,7 @@ import { sweepsGetConfig } from "@moovio/sdk/funcs/sweepsGetConfig.js";
257
253
  // Use `MoovCore` for best tree-shaking performance.
258
254
  // You can create one instance of it to use across an application.
259
255
  const moov = new MoovCore({
256
+ xMoovVersion: "v2024.01.00",
260
257
  security: {
261
258
  username: "",
262
259
  password: "",
@@ -268,15 +265,12 @@ async function run() {
268
265
  accountID: "ae1c2e76-3195-4fc8-b922-b7af6dcf1aad",
269
266
  sweepConfigID: "bfddff28-5291-4d9b-a0f8-22a0895e8486",
270
267
  });
271
-
272
- if (!res.ok) {
273
- throw res.error;
268
+ if (res.ok) {
269
+ const { value: result } = res;
270
+ console.log(result);
271
+ } else {
272
+ console.log("sweepsGetConfig failed:", res.error);
274
273
  }
275
-
276
- const { value: result } = res;
277
-
278
- // Handle the result
279
- console.log(result);
280
274
  }
281
275
 
282
276
  run();
@@ -314,6 +308,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.write` scope.
314
308
  import { Moov } from "@moovio/sdk";
315
309
 
316
310
  const moov = new Moov({
311
+ xMoovVersion: "v2024.01.00",
317
312
  security: {
318
313
  username: "",
319
314
  password: "",
@@ -329,7 +324,6 @@ async function run() {
329
324
  },
330
325
  });
331
326
 
332
- // Handle the result
333
327
  console.log(result);
334
328
  }
335
329
 
@@ -347,6 +341,7 @@ import { sweepsUpdateConfig } from "@moovio/sdk/funcs/sweepsUpdateConfig.js";
347
341
  // Use `MoovCore` for best tree-shaking performance.
348
342
  // You can create one instance of it to use across an application.
349
343
  const moov = new MoovCore({
344
+ xMoovVersion: "v2024.01.00",
350
345
  security: {
351
346
  username: "",
352
347
  password: "",
@@ -361,15 +356,12 @@ async function run() {
361
356
  status: "disabled",
362
357
  },
363
358
  });
364
-
365
- if (!res.ok) {
366
- throw res.error;
359
+ if (res.ok) {
360
+ const { value: result } = res;
361
+ console.log(result);
362
+ } else {
363
+ console.log("sweepsUpdateConfig failed:", res.error);
367
364
  }
368
-
369
- const { value: result } = res;
370
-
371
- // Handle the result
372
- console.log(result);
373
365
  }
374
366
 
375
367
  run();
@@ -409,6 +401,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
409
401
  import { Moov } from "@moovio/sdk";
410
402
 
411
403
  const moov = new Moov({
404
+ xMoovVersion: "v2024.01.00",
412
405
  security: {
413
406
  username: "",
414
407
  password: "",
@@ -423,7 +416,6 @@ async function run() {
423
416
  count: 20,
424
417
  });
425
418
 
426
- // Handle the result
427
419
  console.log(result);
428
420
  }
429
421
 
@@ -441,6 +433,7 @@ import { sweepsList } from "@moovio/sdk/funcs/sweepsList.js";
441
433
  // Use `MoovCore` for best tree-shaking performance.
442
434
  // You can create one instance of it to use across an application.
443
435
  const moov = new MoovCore({
436
+ xMoovVersion: "v2024.01.00",
444
437
  security: {
445
438
  username: "",
446
439
  password: "",
@@ -454,15 +447,12 @@ async function run() {
454
447
  skip: 60,
455
448
  count: 20,
456
449
  });
457
-
458
- if (!res.ok) {
459
- throw res.error;
450
+ if (res.ok) {
451
+ const { value: result } = res;
452
+ console.log(result);
453
+ } else {
454
+ console.log("sweepsList failed:", res.error);
460
455
  }
461
-
462
- const { value: result } = res;
463
-
464
- // Handle the result
465
- console.log(result);
466
456
  }
467
457
 
468
458
  run();
@@ -500,6 +490,7 @@ you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
500
490
  import { Moov } from "@moovio/sdk";
501
491
 
502
492
  const moov = new Moov({
493
+ xMoovVersion: "v2024.01.00",
503
494
  security: {
504
495
  username: "",
505
496
  password: "",
@@ -513,7 +504,6 @@ async function run() {
513
504
  sweepID: "c88c9731-06c2-4b4a-a7d2-34c8b936d9ae",
514
505
  });
515
506
 
516
- // Handle the result
517
507
  console.log(result);
518
508
  }
519
509
 
@@ -531,6 +521,7 @@ import { sweepsGet } from "@moovio/sdk/funcs/sweepsGet.js";
531
521
  // Use `MoovCore` for best tree-shaking performance.
532
522
  // You can create one instance of it to use across an application.
533
523
  const moov = new MoovCore({
524
+ xMoovVersion: "v2024.01.00",
534
525
  security: {
535
526
  username: "",
536
527
  password: "",
@@ -543,15 +534,12 @@ async function run() {
543
534
  walletID: "e63a4638-ad67-44fb-9b59-ed7311023602",
544
535
  sweepID: "c88c9731-06c2-4b4a-a7d2-34c8b936d9ae",
545
536
  });
546
-
547
- if (!res.ok) {
548
- throw res.error;
537
+ if (res.ok) {
538
+ const { value: result } = res;
539
+ console.log(result);
540
+ } else {
541
+ console.log("sweepsGet failed:", res.error);
549
542
  }
550
-
551
- const { value: result } = res;
552
-
553
- // Handle the result
554
- console.log(result);
555
543
  }
556
544
 
557
545
  run();
@@ -35,6 +35,7 @@ you'll need to specify the `/terminal-applications.write` scope.
35
35
  import { Moov } from "@moovio/sdk";
36
36
 
37
37
  const moov = new Moov({
38
+ xMoovVersion: "v2024.01.00",
38
39
  security: {
39
40
  username: "",
40
41
  password: "",
@@ -50,7 +51,6 @@ async function run() {
50
51
  versionCode: "1.0.0",
51
52
  });
52
53
 
53
- // Handle the result
54
54
  console.log(result);
55
55
  }
56
56
 
@@ -68,6 +68,7 @@ import { terminalApplicationsCreate } from "@moovio/sdk/funcs/terminalApplicatio
68
68
  // Use `MoovCore` for best tree-shaking performance.
69
69
  // You can create one instance of it to use across an application.
70
70
  const moov = new MoovCore({
71
+ xMoovVersion: "v2024.01.00",
71
72
  security: {
72
73
  username: "",
73
74
  password: "",
@@ -82,15 +83,12 @@ async function run() {
82
83
  sha256Digest: "1234567890",
83
84
  versionCode: "1.0.0",
84
85
  });
85
-
86
- if (!res.ok) {
87
- throw res.error;
86
+ if (res.ok) {
87
+ const { value: result } = res;
88
+ console.log(result);
89
+ } else {
90
+ console.log("terminalApplicationsCreate failed:", res.error);
88
91
  }
89
-
90
- const { value: result } = res;
91
-
92
- // Handle the result
93
- console.log(result);
94
92
  }
95
93
 
96
94
  run();
@@ -130,6 +128,7 @@ you'll need to specify the `/terminal-applications.read` scope.
130
128
  import { Moov } from "@moovio/sdk";
131
129
 
132
130
  const moov = new Moov({
131
+ xMoovVersion: "v2024.01.00",
133
132
  security: {
134
133
  username: "",
135
134
  password: "",
@@ -139,7 +138,6 @@ const moov = new Moov({
139
138
  async function run() {
140
139
  const result = await moov.terminalApplications.list({});
141
140
 
142
- // Handle the result
143
141
  console.log(result);
144
142
  }
145
143
 
@@ -157,6 +155,7 @@ import { terminalApplicationsList } from "@moovio/sdk/funcs/terminalApplications
157
155
  // Use `MoovCore` for best tree-shaking performance.
158
156
  // You can create one instance of it to use across an application.
159
157
  const moov = new MoovCore({
158
+ xMoovVersion: "v2024.01.00",
160
159
  security: {
161
160
  username: "",
162
161
  password: "",
@@ -165,15 +164,12 @@ const moov = new MoovCore({
165
164
 
166
165
  async function run() {
167
166
  const res = await terminalApplicationsList(moov, {});
168
-
169
- if (!res.ok) {
170
- throw res.error;
167
+ if (res.ok) {
168
+ const { value: result } = res;
169
+ console.log(result);
170
+ } else {
171
+ console.log("terminalApplicationsList failed:", res.error);
171
172
  }
172
-
173
- const { value: result } = res;
174
-
175
- // Handle the result
176
- console.log(result);
177
173
  }
178
174
 
179
175
  run();
@@ -211,6 +207,7 @@ you'll need to specify the `/terminal-applications.read` scope.
211
207
  import { Moov } from "@moovio/sdk";
212
208
 
213
209
  const moov = new Moov({
210
+ xMoovVersion: "v2024.01.00",
214
211
  security: {
215
212
  username: "",
216
213
  password: "",
@@ -222,7 +219,6 @@ async function run() {
222
219
  terminalApplicationID: "12345678-1234-1234-1234-123456789012",
223
220
  });
224
221
 
225
- // Handle the result
226
222
  console.log(result);
227
223
  }
228
224
 
@@ -240,6 +236,7 @@ import { terminalApplicationsGet } from "@moovio/sdk/funcs/terminalApplicationsG
240
236
  // Use `MoovCore` for best tree-shaking performance.
241
237
  // You can create one instance of it to use across an application.
242
238
  const moov = new MoovCore({
239
+ xMoovVersion: "v2024.01.00",
243
240
  security: {
244
241
  username: "",
245
242
  password: "",
@@ -250,15 +247,12 @@ async function run() {
250
247
  const res = await terminalApplicationsGet(moov, {
251
248
  terminalApplicationID: "12345678-1234-1234-1234-123456789012",
252
249
  });
253
-
254
- if (!res.ok) {
255
- throw res.error;
250
+ if (res.ok) {
251
+ const { value: result } = res;
252
+ console.log(result);
253
+ } else {
254
+ console.log("terminalApplicationsGet failed:", res.error);
256
255
  }
257
-
258
- const { value: result } = res;
259
-
260
- // Handle the result
261
- console.log(result);
262
256
  }
263
257
 
264
258
  run();
@@ -296,6 +290,7 @@ you'll need to specify the `/terminal-applications.write` scope.
296
290
  import { Moov } from "@moovio/sdk";
297
291
 
298
292
  const moov = new Moov({
293
+ xMoovVersion: "v2024.01.00",
299
294
  security: {
300
295
  username: "",
301
296
  password: "",
@@ -307,7 +302,6 @@ async function run() {
307
302
  terminalApplicationID: "12345678-1234-1234-1234-123456789012",
308
303
  });
309
304
 
310
- // Handle the result
311
305
  console.log(result);
312
306
  }
313
307
 
@@ -325,6 +319,7 @@ import { terminalApplicationsDelete } from "@moovio/sdk/funcs/terminalApplicatio
325
319
  // Use `MoovCore` for best tree-shaking performance.
326
320
  // You can create one instance of it to use across an application.
327
321
  const moov = new MoovCore({
322
+ xMoovVersion: "v2024.01.00",
328
323
  security: {
329
324
  username: "",
330
325
  password: "",
@@ -335,15 +330,12 @@ async function run() {
335
330
  const res = await terminalApplicationsDelete(moov, {
336
331
  terminalApplicationID: "12345678-1234-1234-1234-123456789012",
337
332
  });
338
-
339
- if (!res.ok) {
340
- throw res.error;
333
+ if (res.ok) {
334
+ const { value: result } = res;
335
+ console.log(result);
336
+ } else {
337
+ console.log("terminalApplicationsDelete failed:", res.error);
341
338
  }
342
-
343
- const { value: result } = res;
344
-
345
- // Handle the result
346
- console.log(result);
347
339
  }
348
340
 
349
341
  run();