@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
@@ -56,6 +56,7 @@ you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.
56
56
  import { Moov } from "@moovio/sdk";
57
57
 
58
58
  const moov = new Moov({
59
+ xMoovVersion: "v2024.01.00",
59
60
  security: {
60
61
  username: "",
61
62
  password: "",
@@ -72,7 +73,6 @@ async function run() {
72
73
  },
73
74
  });
74
75
 
75
- // Handle the result
76
76
  console.log(result);
77
77
  }
78
78
 
@@ -90,6 +90,7 @@ import { applePayRegisterMerchantDomains } from "@moovio/sdk/funcs/applePayRegis
90
90
  // Use `MoovCore` for best tree-shaking performance.
91
91
  // You can create one instance of it to use across an application.
92
92
  const moov = new MoovCore({
93
+ xMoovVersion: "v2024.01.00",
93
94
  security: {
94
95
  username: "",
95
96
  password: "",
@@ -105,15 +106,12 @@ async function run() {
105
106
  ],
106
107
  },
107
108
  });
108
-
109
- if (!res.ok) {
110
- throw res.error;
109
+ if (res.ok) {
110
+ const { value: result } = res;
111
+ console.log(result);
112
+ } else {
113
+ console.log("applePayRegisterMerchantDomains failed:", res.error);
111
114
  }
112
-
113
- const { value: result } = res;
114
-
115
- // Handle the result
116
- console.log(result);
117
115
  }
118
116
 
119
117
  run();
@@ -155,6 +153,7 @@ you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.
155
153
  import { Moov } from "@moovio/sdk";
156
154
 
157
155
  const moov = new Moov({
156
+ xMoovVersion: "v2024.01.00",
158
157
  security: {
159
158
  username: "",
160
159
  password: "",
@@ -174,7 +173,6 @@ async function run() {
174
173
  },
175
174
  });
176
175
 
177
- // Handle the result
178
176
  console.log(result);
179
177
  }
180
178
 
@@ -192,6 +190,7 @@ import { applePayUpdateMerchantDomains } from "@moovio/sdk/funcs/applePayUpdateM
192
190
  // Use `MoovCore` for best tree-shaking performance.
193
191
  // You can create one instance of it to use across an application.
194
192
  const moov = new MoovCore({
193
+ xMoovVersion: "v2024.01.00",
195
194
  security: {
196
195
  username: "",
197
196
  password: "",
@@ -210,15 +209,12 @@ async function run() {
210
209
  ],
211
210
  },
212
211
  });
213
-
214
- if (!res.ok) {
215
- throw res.error;
212
+ if (res.ok) {
213
+ const { value: result } = res;
214
+ console.log(result);
215
+ } else {
216
+ console.log("applePayUpdateMerchantDomains failed:", res.error);
216
217
  }
217
-
218
- const { value: result } = res;
219
-
220
- // Handle the result
221
- console.log(result);
222
218
  }
223
219
 
224
220
  run();
@@ -259,6 +255,7 @@ you'll need to specify the `/accounts/{accountID}/apple-pay.read` scope.
259
255
  import { Moov } from "@moovio/sdk";
260
256
 
261
257
  const moov = new Moov({
258
+ xMoovVersion: "v2024.01.00",
262
259
  security: {
263
260
  username: "",
264
261
  password: "",
@@ -270,7 +267,6 @@ async function run() {
270
267
  accountID: "28704d00-d07b-47db-9e54-016a9713d697",
271
268
  });
272
269
 
273
- // Handle the result
274
270
  console.log(result);
275
271
  }
276
272
 
@@ -288,6 +284,7 @@ import { applePayGetMerchantDomains } from "@moovio/sdk/funcs/applePayGetMerchan
288
284
  // Use `MoovCore` for best tree-shaking performance.
289
285
  // You can create one instance of it to use across an application.
290
286
  const moov = new MoovCore({
287
+ xMoovVersion: "v2024.01.00",
291
288
  security: {
292
289
  username: "",
293
290
  password: "",
@@ -298,15 +295,12 @@ async function run() {
298
295
  const res = await applePayGetMerchantDomains(moov, {
299
296
  accountID: "28704d00-d07b-47db-9e54-016a9713d697",
300
297
  });
301
-
302
- if (!res.ok) {
303
- throw res.error;
298
+ if (res.ok) {
299
+ const { value: result } = res;
300
+ console.log(result);
301
+ } else {
302
+ console.log("applePayGetMerchantDomains failed:", res.error);
304
303
  }
305
-
306
- const { value: result } = res;
307
-
308
- // Handle the result
309
- console.log(result);
310
304
  }
311
305
 
312
306
  run();
@@ -347,6 +341,7 @@ you'll need to specify the `/accounts/{accountID}/apple-pay.write` scope.
347
341
  import { Moov } from "@moovio/sdk";
348
342
 
349
343
  const moov = new Moov({
344
+ xMoovVersion: "v2024.01.00",
350
345
  security: {
351
346
  username: "",
352
347
  password: "",
@@ -362,7 +357,6 @@ async function run() {
362
357
  },
363
358
  });
364
359
 
365
- // Handle the result
366
360
  console.log(result);
367
361
  }
368
362
 
@@ -380,6 +374,7 @@ import { applePayCreateSession } from "@moovio/sdk/funcs/applePayCreateSession.j
380
374
  // Use `MoovCore` for best tree-shaking performance.
381
375
  // You can create one instance of it to use across an application.
382
376
  const moov = new MoovCore({
377
+ xMoovVersion: "v2024.01.00",
383
378
  security: {
384
379
  username: "",
385
380
  password: "",
@@ -394,15 +389,12 @@ async function run() {
394
389
  displayName: "Fay11",
395
390
  },
396
391
  });
397
-
398
- if (!res.ok) {
399
- throw res.error;
392
+ if (res.ok) {
393
+ const { value: result } = res;
394
+ console.log(result);
395
+ } else {
396
+ console.log("applePayCreateSession failed:", res.error);
400
397
  }
401
-
402
- const { value: result } = res;
403
-
404
- // Handle the result
405
- console.log(result);
406
398
  }
407
399
 
408
400
  run();
@@ -444,6 +436,7 @@ you'll need to specify the `/accounts/{accountID}/cards.write` scope.
444
436
  import { Moov } from "@moovio/sdk";
445
437
 
446
438
  const moov = new Moov({
439
+ xMoovVersion: "v2024.01.00",
447
440
  security: {
448
441
  username: "",
449
442
  password: "",
@@ -484,7 +477,6 @@ async function run() {
484
477
  },
485
478
  });
486
479
 
487
- // Handle the result
488
480
  console.log(result);
489
481
  }
490
482
 
@@ -502,6 +494,7 @@ import { applePayLinkToken } from "@moovio/sdk/funcs/applePayLinkToken.js";
502
494
  // Use `MoovCore` for best tree-shaking performance.
503
495
  // You can create one instance of it to use across an application.
504
496
  const moov = new MoovCore({
497
+ xMoovVersion: "v2024.01.00",
505
498
  security: {
506
499
  username: "",
507
500
  password: "",
@@ -541,15 +534,12 @@ async function run() {
541
534
  },
542
535
  },
543
536
  });
544
-
545
- if (!res.ok) {
546
- throw res.error;
537
+ if (res.ok) {
538
+ const { value: result } = res;
539
+ console.log(result);
540
+ } else {
541
+ console.log("applePayLinkToken failed:", res.error);
547
542
  }
548
-
549
- const { value: result } = res;
550
-
551
- // Handle the result
552
- console.log(result);
553
543
  }
554
544
 
555
545
  run();
@@ -22,6 +22,7 @@ Allows clients to notify the authorization server that a previously obtained ref
22
22
  import { Moov } from "@moovio/sdk";
23
23
 
24
24
  const moov = new Moov({
25
+ xMoovVersion: "v2024.01.00",
25
26
  security: {
26
27
  username: "",
27
28
  password: "",
@@ -35,7 +36,6 @@ async function run() {
35
36
  clientSecret: "dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-",
36
37
  });
37
38
 
38
- // Handle the result
39
39
  console.log(result);
40
40
  }
41
41
 
@@ -53,6 +53,7 @@ import { authenticationRevokeAccessToken } from "@moovio/sdk/funcs/authenticatio
53
53
  // Use `MoovCore` for best tree-shaking performance.
54
54
  // You can create one instance of it to use across an application.
55
55
  const moov = new MoovCore({
56
+ xMoovVersion: "v2024.01.00",
56
57
  security: {
57
58
  username: "",
58
59
  password: "",
@@ -65,15 +66,12 @@ async function run() {
65
66
  clientId: "5clTR_MdVrrkgxw2",
66
67
  clientSecret: "dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-",
67
68
  });
68
-
69
- if (!res.ok) {
70
- throw res.error;
69
+ if (res.ok) {
70
+ const { value: result } = res;
71
+ console.log(result);
72
+ } else {
73
+ console.log("authenticationRevokeAccessToken failed:", res.error);
71
74
  }
72
-
73
- const { value: result } = res;
74
-
75
- // Handle the result
76
- console.log(result);
77
75
  }
78
76
 
79
77
  run();
@@ -110,6 +108,7 @@ Create or refresh an access token.
110
108
  import { Moov } from "@moovio/sdk";
111
109
 
112
110
  const moov = new Moov({
111
+ xMoovVersion: "v2024.01.00",
113
112
  security: {
114
113
  username: "",
115
114
  password: "",
@@ -125,7 +124,6 @@ async function run() {
125
124
  refreshToken: "eyJhbGc0eSI6TQSIsImN0kpXVCIsImtp6IkpXVsImtpZC0a...",
126
125
  });
127
126
 
128
- // Handle the result
129
127
  console.log(result);
130
128
  }
131
129
 
@@ -143,6 +141,7 @@ import { authenticationCreateAccessToken } from "@moovio/sdk/funcs/authenticatio
143
141
  // Use `MoovCore` for best tree-shaking performance.
144
142
  // You can create one instance of it to use across an application.
145
143
  const moov = new MoovCore({
144
+ xMoovVersion: "v2024.01.00",
146
145
  security: {
147
146
  username: "",
148
147
  password: "",
@@ -157,15 +156,12 @@ async function run() {
157
156
  scope: "/accounts.read /accounts.write",
158
157
  refreshToken: "eyJhbGc0eSI6TQSIsImN0kpXVCIsImtp6IkpXVsImtpZC0a...",
159
158
  });
160
-
161
- if (!res.ok) {
162
- throw res.error;
159
+ if (res.ok) {
160
+ const { value: result } = res;
161
+ console.log(result);
162
+ } else {
163
+ console.log("authenticationCreateAccessToken failed:", res.error);
163
164
  }
164
-
165
- const { value: result } = res;
166
-
167
- // Handle the result
168
- console.log(result);
169
165
  }
170
166
 
171
167
  run();
@@ -23,6 +23,7 @@ you'll need to specify the `/profile-enrichment.read` scope.
23
23
  import { Moov } from "@moovio/sdk";
24
24
 
25
25
  const moov = new Moov({
26
+ xMoovVersion: "v2024.01.00",
26
27
  security: {
27
28
  username: "",
28
29
  password: "",
@@ -34,7 +35,6 @@ async function run() {
34
35
  uniqueID: "<id>",
35
36
  });
36
37
 
37
- // Handle the result
38
38
  console.log(result);
39
39
  }
40
40
 
@@ -52,6 +52,7 @@ import { avatarsGet } from "@moovio/sdk/funcs/avatarsGet.js";
52
52
  // Use `MoovCore` for best tree-shaking performance.
53
53
  // You can create one instance of it to use across an application.
54
54
  const moov = new MoovCore({
55
+ xMoovVersion: "v2024.01.00",
55
56
  security: {
56
57
  username: "",
57
58
  password: "",
@@ -62,15 +63,12 @@ async function run() {
62
63
  const res = await avatarsGet(moov, {
63
64
  uniqueID: "<id>",
64
65
  });
65
-
66
- if (!res.ok) {
67
- throw res.error;
66
+ if (res.ok) {
67
+ const { value: result } = res;
68
+ console.log(result);
69
+ } else {
70
+ console.log("avatarsGet failed:", res.error);
68
71
  }
69
-
70
- const { value: result } = res;
71
-
72
- // Handle the result
73
- console.log(result);
74
72
  }
75
73
 
76
74
  run();