@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/capabilities/README.md DELETED
@@ -1,380 +0,0 @@
1
- # Capabilities
2
- (*capabilities*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Retrieve all the capabilities an account has requested.
9
-
10
- Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) 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}/capabilities.read` scope.
14
- * [request](#request) - Request capabilities for a specific account. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
15
-
16
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
17
- you'll need to specify the `/accounts/{accountID}/capabilities.write` scope.
18
- * [get](#get) - Retrieve a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
19
-
20
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
21
- you'll need to specify the `/accounts/{accountID}/capabilities.read` scope.
22
- * [disable](#disable) - Disable a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) 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}/capabilities.write` scope.
26
-
27
- ## list
28
-
29
- Retrieve all the capabilities an account has requested.
30
-
31
- Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
32
-
33
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
34
- you'll need to specify the `/accounts/{accountID}/capabilities.read` scope.
35
-
36
- ### Example Usage
37
-
38
- <!-- UsageSnippet language="typescript" operationID="listCapabilities" method="get" path="/accounts/{accountID}/capabilities" -->
39
- ```typescript
40
- import { Moov } from "@moovio/sdk";
41
-
42
- const moov = new Moov({
43
- xMoovVersion: "v2024.01.00",
44
- security: {
45
- username: "",
46
- password: "",
47
- },
48
- });
49
-
50
- async function run() {
51
- const result = await moov.capabilities.list({
52
- accountID: "1a50ab1c-1714-49e7-a016-cea17b33511a",
53
- });
54
-
55
- console.log(result);
56
- }
57
-
58
- run();
59
- ```
60
-
61
- ### Standalone function
62
-
63
- The standalone function version of this method:
64
-
65
- ```typescript
66
- import { MoovCore } from "@moovio/sdk/core.js";
67
- import { capabilitiesList } from "@moovio/sdk/funcs/capabilitiesList.js";
68
-
69
- // Use `MoovCore` for best tree-shaking performance.
70
- // You can create one instance of it to use across an application.
71
- const moov = new MoovCore({
72
- xMoovVersion: "v2024.01.00",
73
- security: {
74
- username: "",
75
- password: "",
76
- },
77
- });
78
-
79
- async function run() {
80
- const res = await capabilitiesList(moov, {
81
- accountID: "1a50ab1c-1714-49e7-a016-cea17b33511a",
82
- });
83
- if (res.ok) {
84
- const { value: result } = res;
85
- console.log(result);
86
- } else {
87
- console.log("capabilitiesList failed:", res.error);
88
- }
89
- }
90
-
91
- run();
92
- ```
93
-
94
- ### Parameters
95
-
96
- | Parameter | Type | Required | Description |
97
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
98
- | `request` | [operations.ListCapabilitiesRequest](../../models/operations/listcapabilitiesrequest.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.ListCapabilitiesResponse](../../models/operations/listcapabilitiesresponse.md)\>**
106
-
107
- ### Errors
108
-
109
- | Error Type | Status Code | Content Type |
110
- | --------------- | --------------- | --------------- |
111
- | errors.APIError | 4XX, 5XX | \*/\* |
112
-
113
- ## request
114
-
115
- Request capabilities for a specific account. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
116
-
117
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
118
- you'll need to specify the `/accounts/{accountID}/capabilities.write` scope.
119
-
120
- ### Example Usage
121
-
122
- <!-- UsageSnippet language="typescript" operationID="requestCapabilities" method="post" path="/accounts/{accountID}/capabilities" -->
123
- ```typescript
124
- import { Moov } from "@moovio/sdk";
125
-
126
- const moov = new Moov({
127
- xMoovVersion: "v2024.01.00",
128
- security: {
129
- username: "",
130
- password: "",
131
- },
132
- });
133
-
134
- async function run() {
135
- const result = await moov.capabilities.request({
136
- accountID: "0de140d5-cc78-4eeb-ab00-1f51aaf6c814",
137
- addCapabilities: {
138
- capabilities: [
139
- "collect-funds",
140
- ],
141
- },
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 { capabilitiesRequest } from "@moovio/sdk/funcs/capabilitiesRequest.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 capabilitiesRequest(moov, {
170
- accountID: "0de140d5-cc78-4eeb-ab00-1f51aaf6c814",
171
- addCapabilities: {
172
- capabilities: [
173
- "collect-funds",
174
- ],
175
- },
176
- });
177
- if (res.ok) {
178
- const { value: result } = res;
179
- console.log(result);
180
- } else {
181
- console.log("capabilitiesRequest failed:", res.error);
182
- }
183
- }
184
-
185
- run();
186
- ```
187
-
188
- ### Parameters
189
-
190
- | Parameter | Type | Required | Description |
191
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
192
- | `request` | [operations.RequestCapabilitiesRequest](../../models/operations/requestcapabilitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
193
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
194
- | `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. |
195
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
196
-
197
- ### Response
198
-
199
- **Promise\<[operations.RequestCapabilitiesResponse](../../models/operations/requestcapabilitiesresponse.md)\>**
200
-
201
- ### Errors
202
-
203
- | Error Type | Status Code | Content Type |
204
- | --------------------------- | --------------------------- | --------------------------- |
205
- | errors.GenericError | 400, 409 | application/json |
206
- | errors.AddCapabilitiesError | 422 | application/json |
207
- | errors.APIError | 4XX, 5XX | \*/\* |
208
-
209
- ## get
210
-
211
- Retrieve a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
212
-
213
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
214
- you'll need to specify the `/accounts/{accountID}/capabilities.read` scope.
215
-
216
- ### Example Usage
217
-
218
- <!-- UsageSnippet language="typescript" operationID="getCapability" method="get" path="/accounts/{accountID}/capabilities/{capabilityID}" -->
219
- ```typescript
220
- import { Moov } from "@moovio/sdk";
221
-
222
- const moov = new Moov({
223
- xMoovVersion: "v2024.01.00",
224
- security: {
225
- username: "",
226
- password: "",
227
- },
228
- });
229
-
230
- async function run() {
231
- const result = await moov.capabilities.get({
232
- accountID: "c1697ea6-c984-4ba1-9b81-93e5e18660af",
233
- capabilityID: "send-funds",
234
- });
235
-
236
- console.log(result);
237
- }
238
-
239
- run();
240
- ```
241
-
242
- ### Standalone function
243
-
244
- The standalone function version of this method:
245
-
246
- ```typescript
247
- import { MoovCore } from "@moovio/sdk/core.js";
248
- import { capabilitiesGet } from "@moovio/sdk/funcs/capabilitiesGet.js";
249
-
250
- // Use `MoovCore` for best tree-shaking performance.
251
- // You can create one instance of it to use across an application.
252
- const moov = new MoovCore({
253
- xMoovVersion: "v2024.01.00",
254
- security: {
255
- username: "",
256
- password: "",
257
- },
258
- });
259
-
260
- async function run() {
261
- const res = await capabilitiesGet(moov, {
262
- accountID: "c1697ea6-c984-4ba1-9b81-93e5e18660af",
263
- capabilityID: "send-funds",
264
- });
265
- if (res.ok) {
266
- const { value: result } = res;
267
- console.log(result);
268
- } else {
269
- console.log("capabilitiesGet failed:", res.error);
270
- }
271
- }
272
-
273
- run();
274
- ```
275
-
276
- ### Parameters
277
-
278
- | Parameter | Type | Required | Description |
279
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
280
- | `request` | [operations.GetCapabilityRequest](../../models/operations/getcapabilityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
281
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
282
- | `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. |
283
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
284
-
285
- ### Response
286
-
287
- **Promise\<[operations.GetCapabilityResponse](../../models/operations/getcapabilityresponse.md)\>**
288
-
289
- ### Errors
290
-
291
- | Error Type | Status Code | Content Type |
292
- | --------------- | --------------- | --------------- |
293
- | errors.APIError | 4XX, 5XX | \*/\* |
294
-
295
- ## disable
296
-
297
- Disable a specific capability that an account has requested. Read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/) to learn more.
298
-
299
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
300
- you'll need to specify the `/accounts/{accountID}/capabilities.write` scope.
301
-
302
- ### Example Usage
303
-
304
- <!-- UsageSnippet language="typescript" operationID="disableCapability" method="delete" path="/accounts/{accountID}/capabilities/{capabilityID}" -->
305
- ```typescript
306
- import { Moov } from "@moovio/sdk";
307
-
308
- const moov = new Moov({
309
- xMoovVersion: "v2024.01.00",
310
- security: {
311
- username: "",
312
- password: "",
313
- },
314
- });
315
-
316
- async function run() {
317
- const result = await moov.capabilities.disable({
318
- accountID: "2be80c4e-d409-49ea-8a8a-76dfa4006d69",
319
- capabilityID: "transfers",
320
- });
321
-
322
- console.log(result);
323
- }
324
-
325
- run();
326
- ```
327
-
328
- ### Standalone function
329
-
330
- The standalone function version of this method:
331
-
332
- ```typescript
333
- import { MoovCore } from "@moovio/sdk/core.js";
334
- import { capabilitiesDisable } from "@moovio/sdk/funcs/capabilitiesDisable.js";
335
-
336
- // Use `MoovCore` for best tree-shaking performance.
337
- // You can create one instance of it to use across an application.
338
- const moov = new MoovCore({
339
- xMoovVersion: "v2024.01.00",
340
- security: {
341
- username: "",
342
- password: "",
343
- },
344
- });
345
-
346
- async function run() {
347
- const res = await capabilitiesDisable(moov, {
348
- accountID: "2be80c4e-d409-49ea-8a8a-76dfa4006d69",
349
- capabilityID: "transfers",
350
- });
351
- if (res.ok) {
352
- const { value: result } = res;
353
- console.log(result);
354
- } else {
355
- console.log("capabilitiesDisable failed:", res.error);
356
- }
357
- }
358
-
359
- run();
360
- ```
361
-
362
- ### Parameters
363
-
364
- | Parameter | Type | Required | Description |
365
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
366
- | `request` | [operations.DisableCapabilityRequest](../../models/operations/disablecapabilityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
367
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
368
- | `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. |
369
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
370
-
371
- ### Response
372
-
373
- **Promise\<[operations.DisableCapabilityResponse](../../models/operations/disablecapabilityresponse.md)\>**
374
-
375
- ### Errors
376
-
377
- | Error Type | Status Code | Content Type |
378
- | ------------------- | ------------------- | ------------------- |
379
- | errors.GenericError | 400, 409 | application/json |
380
- | errors.APIError | 4XX, 5XX | \*/\* |