@moovio/sdk 0.21.1 → 0.21.4

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 +2 -2
  18. package/lib/config.js +2 -2
  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 +2 -2
  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/onboarding/README.md DELETED
@@ -1,389 +0,0 @@
1
- # Onboarding
2
- (*onboarding*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createInvite](#createinvite) - Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.
9
-
10
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
11
- you'll need to specify the `/accounts.write` scope.
12
- * [listInvites](#listinvites) - List all the onboarding invites created by the caller's account.
13
-
14
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
15
- you'll need to specify the `/accounts.read` scope.
16
- * [getInvite](#getinvite) - Retrieve details about an onboarding invite.
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.read` scope.
20
- * [revokeInvite](#revokeinvite) - Revoke an onboarding invite, rendering the invitation link unusable.
21
-
22
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
23
- you'll need to specify the `/accounts.write` scope.
24
-
25
- ## createInvite
26
-
27
- Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.
28
-
29
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
30
- you'll need to specify the `/accounts.write` scope.
31
-
32
- ### Example Usage
33
-
34
- <!-- UsageSnippet language="typescript" operationID="createOnboardingInvite" method="post" path="/onboarding-invites" -->
35
- ```typescript
36
- import { Moov } from "@moovio/sdk";
37
-
38
- const moov = new Moov({
39
- xMoovVersion: "v2024.01.00",
40
- security: {
41
- username: "",
42
- password: "",
43
- },
44
- });
45
-
46
- async function run() {
47
- const result = await moov.onboarding.createInvite({
48
- scopes: [
49
- "accounts.read",
50
- ],
51
- capabilities: [
52
- "transfers",
53
- ],
54
- feePlanCodes: [
55
- "merchant-direct",
56
- ],
57
- prefill: {
58
- accountType: "business",
59
- profile: {
60
- business: {
61
- legalBusinessName: "Whole Body Fitness LLC",
62
- },
63
- },
64
- },
65
- });
66
-
67
- console.log(result);
68
- }
69
-
70
- run();
71
- ```
72
-
73
- ### Standalone function
74
-
75
- The standalone function version of this method:
76
-
77
- ```typescript
78
- import { MoovCore } from "@moovio/sdk/core.js";
79
- import { onboardingCreateInvite } from "@moovio/sdk/funcs/onboardingCreateInvite.js";
80
-
81
- // Use `MoovCore` for best tree-shaking performance.
82
- // You can create one instance of it to use across an application.
83
- const moov = new MoovCore({
84
- xMoovVersion: "v2024.01.00",
85
- security: {
86
- username: "",
87
- password: "",
88
- },
89
- });
90
-
91
- async function run() {
92
- const res = await onboardingCreateInvite(moov, {
93
- scopes: [
94
- "accounts.read",
95
- ],
96
- capabilities: [
97
- "transfers",
98
- ],
99
- feePlanCodes: [
100
- "merchant-direct",
101
- ],
102
- prefill: {
103
- accountType: "business",
104
- profile: {
105
- business: {
106
- legalBusinessName: "Whole Body Fitness LLC",
107
- },
108
- },
109
- },
110
- });
111
- if (res.ok) {
112
- const { value: result } = res;
113
- console.log(result);
114
- } else {
115
- console.log("onboardingCreateInvite failed:", res.error);
116
- }
117
- }
118
-
119
- run();
120
- ```
121
-
122
- ### Parameters
123
-
124
- | Parameter | Type | Required | Description |
125
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
126
- | `request` | [components.OnboardingInviteRequest](../../models/components/onboardinginviterequest.md) | :heavy_check_mark: | The request object to use for the request. |
127
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
128
- | `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. |
129
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
130
-
131
- ### Response
132
-
133
- **Promise\<[operations.CreateOnboardingInviteResponse](../../models/operations/createonboardinginviteresponse.md)\>**
134
-
135
- ### Errors
136
-
137
- | Error Type | Status Code | Content Type |
138
- | ---------------------------- | ---------------------------- | ---------------------------- |
139
- | errors.GenericError | 400, 409 | application/json |
140
- | errors.OnboardingInviteError | 422 | application/json |
141
- | errors.APIError | 4XX, 5XX | \*/\* |
142
-
143
- ## listInvites
144
-
145
- List all the onboarding invites created by the caller's account.
146
-
147
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
148
- you'll need to specify the `/accounts.read` scope.
149
-
150
- ### Example Usage
151
-
152
- <!-- UsageSnippet language="typescript" operationID="listOnboardingInvites" method="get" path="/onboarding-invites" -->
153
- ```typescript
154
- import { Moov } from "@moovio/sdk";
155
-
156
- const moov = new Moov({
157
- xMoovVersion: "v2024.01.00",
158
- security: {
159
- username: "",
160
- password: "",
161
- },
162
- });
163
-
164
- async function run() {
165
- const result = await moov.onboarding.listInvites({});
166
-
167
- console.log(result);
168
- }
169
-
170
- run();
171
- ```
172
-
173
- ### Standalone function
174
-
175
- The standalone function version of this method:
176
-
177
- ```typescript
178
- import { MoovCore } from "@moovio/sdk/core.js";
179
- import { onboardingListInvites } from "@moovio/sdk/funcs/onboardingListInvites.js";
180
-
181
- // Use `MoovCore` for best tree-shaking performance.
182
- // You can create one instance of it to use across an application.
183
- const moov = new MoovCore({
184
- xMoovVersion: "v2024.01.00",
185
- security: {
186
- username: "",
187
- password: "",
188
- },
189
- });
190
-
191
- async function run() {
192
- const res = await onboardingListInvites(moov, {});
193
- if (res.ok) {
194
- const { value: result } = res;
195
- console.log(result);
196
- } else {
197
- console.log("onboardingListInvites failed:", res.error);
198
- }
199
- }
200
-
201
- run();
202
- ```
203
-
204
- ### Parameters
205
-
206
- | Parameter | Type | Required | Description |
207
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
208
- | `request` | [operations.ListOnboardingInvitesRequest](../../models/operations/listonboardinginvitesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
209
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
210
- | `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. |
211
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
212
-
213
- ### Response
214
-
215
- **Promise\<[operations.ListOnboardingInvitesResponse](../../models/operations/listonboardinginvitesresponse.md)\>**
216
-
217
- ### Errors
218
-
219
- | Error Type | Status Code | Content Type |
220
- | --------------- | --------------- | --------------- |
221
- | errors.APIError | 4XX, 5XX | \*/\* |
222
-
223
- ## getInvite
224
-
225
- Retrieve details about an onboarding invite.
226
-
227
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
228
- you'll need to specify the `/accounts.read` scope.
229
-
230
- ### Example Usage
231
-
232
- <!-- UsageSnippet language="typescript" operationID="getOnboardingInvite" method="get" path="/onboarding-invites/{code}" -->
233
- ```typescript
234
- import { Moov } from "@moovio/sdk";
235
-
236
- const moov = new Moov({
237
- xMoovVersion: "v2024.01.00",
238
- security: {
239
- username: "",
240
- password: "",
241
- },
242
- });
243
-
244
- async function run() {
245
- const result = await moov.onboarding.getInvite({
246
- code: "N1IA5eWYNh",
247
- });
248
-
249
- console.log(result);
250
- }
251
-
252
- run();
253
- ```
254
-
255
- ### Standalone function
256
-
257
- The standalone function version of this method:
258
-
259
- ```typescript
260
- import { MoovCore } from "@moovio/sdk/core.js";
261
- import { onboardingGetInvite } from "@moovio/sdk/funcs/onboardingGetInvite.js";
262
-
263
- // Use `MoovCore` for best tree-shaking performance.
264
- // You can create one instance of it to use across an application.
265
- const moov = new MoovCore({
266
- xMoovVersion: "v2024.01.00",
267
- security: {
268
- username: "",
269
- password: "",
270
- },
271
- });
272
-
273
- async function run() {
274
- const res = await onboardingGetInvite(moov, {
275
- code: "N1IA5eWYNh",
276
- });
277
- if (res.ok) {
278
- const { value: result } = res;
279
- console.log(result);
280
- } else {
281
- console.log("onboardingGetInvite failed:", res.error);
282
- }
283
- }
284
-
285
- run();
286
- ```
287
-
288
- ### Parameters
289
-
290
- | Parameter | Type | Required | Description |
291
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
292
- | `request` | [operations.GetOnboardingInviteRequest](../../models/operations/getonboardinginviterequest.md) | :heavy_check_mark: | The request object to use for the request. |
293
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
294
- | `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. |
295
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
296
-
297
- ### Response
298
-
299
- **Promise\<[operations.GetOnboardingInviteResponse](../../models/operations/getonboardinginviteresponse.md)\>**
300
-
301
- ### Errors
302
-
303
- | Error Type | Status Code | Content Type |
304
- | --------------- | --------------- | --------------- |
305
- | errors.APIError | 4XX, 5XX | \*/\* |
306
-
307
- ## revokeInvite
308
-
309
- Revoke an onboarding invite, rendering the invitation link unusable.
310
-
311
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
312
- you'll need to specify the `/accounts.write` scope.
313
-
314
- ### Example Usage
315
-
316
- <!-- UsageSnippet language="typescript" operationID="revokeOnboardingInvite" method="delete" path="/onboarding-invites/{code}" -->
317
- ```typescript
318
- import { Moov } from "@moovio/sdk";
319
-
320
- const moov = new Moov({
321
- xMoovVersion: "v2024.01.00",
322
- security: {
323
- username: "",
324
- password: "",
325
- },
326
- });
327
-
328
- async function run() {
329
- const result = await moov.onboarding.revokeInvite({
330
- code: "N1IA5eWYNh",
331
- });
332
-
333
- console.log(result);
334
- }
335
-
336
- run();
337
- ```
338
-
339
- ### Standalone function
340
-
341
- The standalone function version of this method:
342
-
343
- ```typescript
344
- import { MoovCore } from "@moovio/sdk/core.js";
345
- import { onboardingRevokeInvite } from "@moovio/sdk/funcs/onboardingRevokeInvite.js";
346
-
347
- // Use `MoovCore` for best tree-shaking performance.
348
- // You can create one instance of it to use across an application.
349
- const moov = new MoovCore({
350
- xMoovVersion: "v2024.01.00",
351
- security: {
352
- username: "",
353
- password: "",
354
- },
355
- });
356
-
357
- async function run() {
358
- const res = await onboardingRevokeInvite(moov, {
359
- code: "N1IA5eWYNh",
360
- });
361
- if (res.ok) {
362
- const { value: result } = res;
363
- console.log(result);
364
- } else {
365
- console.log("onboardingRevokeInvite failed:", res.error);
366
- }
367
- }
368
-
369
- run();
370
- ```
371
-
372
- ### Parameters
373
-
374
- | Parameter | Type | Required | Description |
375
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
376
- | `request` | [operations.RevokeOnboardingInviteRequest](../../models/operations/revokeonboardinginviterequest.md) | :heavy_check_mark: | The request object to use for the request. |
377
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
378
- | `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. |
379
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
380
-
381
- ### Response
382
-
383
- **Promise\<[operations.RevokeOnboardingInviteResponse](../../models/operations/revokeonboardinginviteresponse.md)\>**
384
-
385
- ### Errors
386
-
387
- | Error Type | Status Code | Content Type |
388
- | --------------- | --------------- | --------------- |
389
- | errors.APIError | 4XX, 5XX | \*/\* |