@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/terminalapplications/README.md DELETED
@@ -1,460 +0,0 @@
1
- # TerminalApplications
2
- (*terminalApplications*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create a new terminal application.
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 `/terminal-applications.write` scope.
12
- * [list](#list) - List all the terminal applications for a Moov 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 `/terminal-applications.read` scope.
16
- * [get](#get) - Fetch a specific terminal application.
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 `/terminal-applications.read` scope.
20
- * [delete](#delete) - Delete a specific terminal application.
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 `/terminal-applications.write` scope.
24
- * [createVersion](#createversion) - Register a new version of a terminal application. For Android applications, this is used to register a new version code of the application.
25
-
26
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
27
- you'll need to specify the `/terminal-applications.write` scope.
28
-
29
- ## create
30
-
31
- Create a new terminal application.
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 `/terminal-applications.write` scope.
35
-
36
- ### Example Usage
37
-
38
- <!-- UsageSnippet language="typescript" operationID="createTerminalApplication" method="post" path="/terminal-applications" -->
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.terminalApplications.create({
52
- platform: "android",
53
- packageName: "com.example.app",
54
- sha256Digest: "AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD",
55
- versionCode: "20332277",
56
- });
57
-
58
- console.log(result);
59
- }
60
-
61
- run();
62
- ```
63
-
64
- ### Standalone function
65
-
66
- The standalone function version of this method:
67
-
68
- ```typescript
69
- import { MoovCore } from "@moovio/sdk/core.js";
70
- import { terminalApplicationsCreate } from "@moovio/sdk/funcs/terminalApplicationsCreate.js";
71
-
72
- // Use `MoovCore` for best tree-shaking performance.
73
- // You can create one instance of it to use across an application.
74
- const moov = new MoovCore({
75
- xMoovVersion: "v2024.01.00",
76
- security: {
77
- username: "",
78
- password: "",
79
- },
80
- });
81
-
82
- async function run() {
83
- const res = await terminalApplicationsCreate(moov, {
84
- platform: "android",
85
- packageName: "com.example.app",
86
- sha256Digest: "AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD:EE:FF:AA:BB:CC:DD",
87
- versionCode: "20332277",
88
- });
89
- if (res.ok) {
90
- const { value: result } = res;
91
- console.log(result);
92
- } else {
93
- console.log("terminalApplicationsCreate failed:", res.error);
94
- }
95
- }
96
-
97
- run();
98
- ```
99
-
100
- ### Parameters
101
-
102
- | Parameter | Type | Required | Description |
103
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
104
- | `request` | [components.CreateTerminalApplication](../../models/components/createterminalapplication.md) | :heavy_check_mark: | The request object to use for the request. |
105
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
106
- | `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. |
107
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
108
-
109
- ### Response
110
-
111
- **Promise\<[operations.CreateTerminalApplicationResponse](../../models/operations/createterminalapplicationresponse.md)\>**
112
-
113
- ### Errors
114
-
115
- | Error Type | Status Code | Content Type |
116
- | ------------------------------- | ------------------------------- | ------------------------------- |
117
- | errors.GenericError | 400, 409 | application/json |
118
- | errors.TerminalApplicationError | 422 | application/json |
119
- | errors.APIError | 4XX, 5XX | \*/\* |
120
-
121
- ## list
122
-
123
- List all the terminal applications for a Moov Account.
124
-
125
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
126
- you'll need to specify the `/terminal-applications.read` scope.
127
-
128
- ### Example Usage
129
-
130
- <!-- UsageSnippet language="typescript" operationID="listTerminalApplications" method="get" path="/terminal-applications" -->
131
- ```typescript
132
- import { Moov } from "@moovio/sdk";
133
-
134
- const moov = new Moov({
135
- xMoovVersion: "v2024.01.00",
136
- security: {
137
- username: "",
138
- password: "",
139
- },
140
- });
141
-
142
- async function run() {
143
- const result = await moov.terminalApplications.list({});
144
-
145
- console.log(result);
146
- }
147
-
148
- run();
149
- ```
150
-
151
- ### Standalone function
152
-
153
- The standalone function version of this method:
154
-
155
- ```typescript
156
- import { MoovCore } from "@moovio/sdk/core.js";
157
- import { terminalApplicationsList } from "@moovio/sdk/funcs/terminalApplicationsList.js";
158
-
159
- // Use `MoovCore` for best tree-shaking performance.
160
- // You can create one instance of it to use across an application.
161
- const moov = new MoovCore({
162
- xMoovVersion: "v2024.01.00",
163
- security: {
164
- username: "",
165
- password: "",
166
- },
167
- });
168
-
169
- async function run() {
170
- const res = await terminalApplicationsList(moov, {});
171
- if (res.ok) {
172
- const { value: result } = res;
173
- console.log(result);
174
- } else {
175
- console.log("terminalApplicationsList failed:", res.error);
176
- }
177
- }
178
-
179
- run();
180
- ```
181
-
182
- ### Parameters
183
-
184
- | Parameter | Type | Required | Description |
185
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
186
- | `request` | [operations.ListTerminalApplicationsRequest](../../models/operations/listterminalapplicationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
187
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
188
- | `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. |
189
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
190
-
191
- ### Response
192
-
193
- **Promise\<[operations.ListTerminalApplicationsResponse](../../models/operations/listterminalapplicationsresponse.md)\>**
194
-
195
- ### Errors
196
-
197
- | Error Type | Status Code | Content Type |
198
- | --------------- | --------------- | --------------- |
199
- | errors.APIError | 4XX, 5XX | \*/\* |
200
-
201
- ## get
202
-
203
- Fetch a specific terminal application.
204
-
205
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
206
- you'll need to specify the `/terminal-applications.read` scope.
207
-
208
- ### Example Usage
209
-
210
- <!-- UsageSnippet language="typescript" operationID="getTerminalApplication" method="get" path="/terminal-applications/{terminalApplicationID}" -->
211
- ```typescript
212
- import { Moov } from "@moovio/sdk";
213
-
214
- const moov = new Moov({
215
- xMoovVersion: "v2024.01.00",
216
- security: {
217
- username: "",
218
- password: "",
219
- },
220
- });
221
-
222
- async function run() {
223
- const result = await moov.terminalApplications.get({
224
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
225
- });
226
-
227
- console.log(result);
228
- }
229
-
230
- run();
231
- ```
232
-
233
- ### Standalone function
234
-
235
- The standalone function version of this method:
236
-
237
- ```typescript
238
- import { MoovCore } from "@moovio/sdk/core.js";
239
- import { terminalApplicationsGet } from "@moovio/sdk/funcs/terminalApplicationsGet.js";
240
-
241
- // Use `MoovCore` for best tree-shaking performance.
242
- // You can create one instance of it to use across an application.
243
- const moov = new MoovCore({
244
- xMoovVersion: "v2024.01.00",
245
- security: {
246
- username: "",
247
- password: "",
248
- },
249
- });
250
-
251
- async function run() {
252
- const res = await terminalApplicationsGet(moov, {
253
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
254
- });
255
- if (res.ok) {
256
- const { value: result } = res;
257
- console.log(result);
258
- } else {
259
- console.log("terminalApplicationsGet failed:", res.error);
260
- }
261
- }
262
-
263
- run();
264
- ```
265
-
266
- ### Parameters
267
-
268
- | Parameter | Type | Required | Description |
269
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
270
- | `request` | [operations.GetTerminalApplicationRequest](../../models/operations/getterminalapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
271
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
272
- | `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. |
273
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
274
-
275
- ### Response
276
-
277
- **Promise\<[operations.GetTerminalApplicationResponse](../../models/operations/getterminalapplicationresponse.md)\>**
278
-
279
- ### Errors
280
-
281
- | Error Type | Status Code | Content Type |
282
- | --------------- | --------------- | --------------- |
283
- | errors.APIError | 4XX, 5XX | \*/\* |
284
-
285
- ## delete
286
-
287
- Delete a specific terminal application.
288
-
289
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
290
- you'll need to specify the `/terminal-applications.write` scope.
291
-
292
- ### Example Usage
293
-
294
- <!-- UsageSnippet language="typescript" operationID="deleteTerminalApplication" method="delete" path="/terminal-applications/{terminalApplicationID}" -->
295
- ```typescript
296
- import { Moov } from "@moovio/sdk";
297
-
298
- const moov = new Moov({
299
- xMoovVersion: "v2024.01.00",
300
- security: {
301
- username: "",
302
- password: "",
303
- },
304
- });
305
-
306
- async function run() {
307
- const result = await moov.terminalApplications.delete({
308
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
309
- });
310
-
311
- console.log(result);
312
- }
313
-
314
- run();
315
- ```
316
-
317
- ### Standalone function
318
-
319
- The standalone function version of this method:
320
-
321
- ```typescript
322
- import { MoovCore } from "@moovio/sdk/core.js";
323
- import { terminalApplicationsDelete } from "@moovio/sdk/funcs/terminalApplicationsDelete.js";
324
-
325
- // Use `MoovCore` for best tree-shaking performance.
326
- // You can create one instance of it to use across an application.
327
- const moov = new MoovCore({
328
- xMoovVersion: "v2024.01.00",
329
- security: {
330
- username: "",
331
- password: "",
332
- },
333
- });
334
-
335
- async function run() {
336
- const res = await terminalApplicationsDelete(moov, {
337
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
338
- });
339
- if (res.ok) {
340
- const { value: result } = res;
341
- console.log(result);
342
- } else {
343
- console.log("terminalApplicationsDelete failed:", res.error);
344
- }
345
- }
346
-
347
- run();
348
- ```
349
-
350
- ### Parameters
351
-
352
- | Parameter | Type | Required | Description |
353
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
354
- | `request` | [operations.DeleteTerminalApplicationRequest](../../models/operations/deleteterminalapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
355
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
356
- | `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. |
357
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
358
-
359
- ### Response
360
-
361
- **Promise\<[operations.DeleteTerminalApplicationResponse](../../models/operations/deleteterminalapplicationresponse.md)\>**
362
-
363
- ### Errors
364
-
365
- | Error Type | Status Code | Content Type |
366
- | ------------------- | ------------------- | ------------------- |
367
- | errors.GenericError | 400, 409 | application/json |
368
- | errors.APIError | 4XX, 5XX | \*/\* |
369
-
370
- ## createVersion
371
-
372
- Register a new version of a terminal application. For Android applications, this is used to register a new version code of the application.
373
-
374
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
375
- you'll need to specify the `/terminal-applications.write` scope.
376
-
377
- ### Example Usage
378
-
379
- <!-- UsageSnippet language="typescript" operationID="createTerminalApplicationVersion" method="post" path="/terminal-applications/{terminalApplicationID}/versions" -->
380
- ```typescript
381
- import { Moov } from "@moovio/sdk";
382
-
383
- const moov = new Moov({
384
- xMoovVersion: "v2024.01.00",
385
- security: {
386
- username: "",
387
- password: "",
388
- },
389
- });
390
-
391
- async function run() {
392
- const result = await moov.terminalApplications.createVersion({
393
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
394
- terminalApplicationVersion: {
395
- version: "20440059",
396
- },
397
- });
398
-
399
- console.log(result);
400
- }
401
-
402
- run();
403
- ```
404
-
405
- ### Standalone function
406
-
407
- The standalone function version of this method:
408
-
409
- ```typescript
410
- import { MoovCore } from "@moovio/sdk/core.js";
411
- import { terminalApplicationsCreateVersion } from "@moovio/sdk/funcs/terminalApplicationsCreateVersion.js";
412
-
413
- // Use `MoovCore` for best tree-shaking performance.
414
- // You can create one instance of it to use across an application.
415
- const moov = new MoovCore({
416
- xMoovVersion: "v2024.01.00",
417
- security: {
418
- username: "",
419
- password: "",
420
- },
421
- });
422
-
423
- async function run() {
424
- const res = await terminalApplicationsCreateVersion(moov, {
425
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
426
- terminalApplicationVersion: {
427
- version: "20440059",
428
- },
429
- });
430
- if (res.ok) {
431
- const { value: result } = res;
432
- console.log(result);
433
- } else {
434
- console.log("terminalApplicationsCreateVersion failed:", res.error);
435
- }
436
- }
437
-
438
- run();
439
- ```
440
-
441
- ### Parameters
442
-
443
- | Parameter | Type | Required | Description |
444
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
445
- | `request` | [operations.CreateTerminalApplicationVersionRequest](../../models/operations/createterminalapplicationversionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
446
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
447
- | `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. |
448
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
449
-
450
- ### Response
451
-
452
- **Promise\<[operations.CreateTerminalApplicationVersionResponse](../../models/operations/createterminalapplicationversionresponse.md)\>**
453
-
454
- ### Errors
455
-
456
- | Error Type | Status Code | Content Type |
457
- | ------------------------------- | ------------------------------- | ------------------------------- |
458
- | errors.GenericError | 400, 409 | application/json |
459
- | errors.TerminalApplicationError | 422 | application/json |
460
- | errors.APIError | 4XX, 5XX | \*/\* |