@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/endtoendencryption/README.md DELETED
@@ -1,174 +0,0 @@
1
- # EndToEndEncryption
2
- (*endToEndEncryption*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [testEncryptedToken](#testencryptedtoken) - Allows for testing a JWE token to ensure it's acceptable by 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 `/ping.read` scope.
12
- * [generateKey](#generatekey) - Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.
13
-
14
- ## testEncryptedToken
15
-
16
- Allows for testing a JWE token to ensure it's acceptable by Moov.
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 `/ping.read` scope.
20
-
21
- ### Example Usage
22
-
23
- <!-- UsageSnippet language="typescript" operationID="testEndToEndToken" method="post" path="/debug/end-to-end-token" -->
24
- ```typescript
25
- import { Moov } from "@moovio/sdk";
26
-
27
- const moov = new Moov({
28
- xMoovVersion: "v2024.01.00",
29
- security: {
30
- username: "",
31
- password: "",
32
- },
33
- });
34
-
35
- async function run() {
36
- const result = await moov.endToEndEncryption.testEncryptedToken({
37
- token: "eyJhbGciOiJFQ0RILUVTK0EyNTZLVyIsImVuYyI6IkEyNTZHQ00iLCJlcGsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTUyMSIsIngiOiJBS0NYVDM1WVdvTm8wbzExNy1SU0dqUGg3alN1NjFmLUhnYkx1dW0xVG1ueTRlcW5yX2hyU0hpY0w1d3gwODRCWDBRZjVTdEtkRUoydzY2ZUJqWHprRV9OIiwieSI6IkFIMEJfT2RaYTQtbG43dGJ4M3VBdlc1NDNQRE9HUXBCTDloRFFNWjlTQXNfOW05UWN3dnhRd1hrb1VrM3VzT1FnVV9ySVFrNFRoZ1NTUzV4UlhKcm5ZaTkifSwia2lkIjoiYmRvV3pLekpKUGw0TVFIaENDa05WYTZlZ1dmYi02V1haSjZKTFZqQ0hWMD0ifQ.HalyoHsfufBJEODd2lD9ThQvvVWw3b2kgWDLHGxmHhMv8rODyLL_Ug.rpQP178t8Ed_pUU2.Sn9UFeVoegAxiMUv11q7l3M0y9YHSLYi2n_JB7n7Pc777_47-icfaxstJemT0IC81w.akkq1EBxzWkBr4vEomSpWA",
38
- });
39
-
40
- console.log(result);
41
- }
42
-
43
- run();
44
- ```
45
-
46
- ### Standalone function
47
-
48
- The standalone function version of this method:
49
-
50
- ```typescript
51
- import { MoovCore } from "@moovio/sdk/core.js";
52
- import { endToEndEncryptionTestEncryptedToken } from "@moovio/sdk/funcs/endToEndEncryptionTestEncryptedToken.js";
53
-
54
- // Use `MoovCore` for best tree-shaking performance.
55
- // You can create one instance of it to use across an application.
56
- const moov = new MoovCore({
57
- xMoovVersion: "v2024.01.00",
58
- security: {
59
- username: "",
60
- password: "",
61
- },
62
- });
63
-
64
- async function run() {
65
- const res = await endToEndEncryptionTestEncryptedToken(moov, {
66
- token: "eyJhbGciOiJFQ0RILUVTK0EyNTZLVyIsImVuYyI6IkEyNTZHQ00iLCJlcGsiOnsia3R5IjoiRUMiLCJjcnYiOiJQLTUyMSIsIngiOiJBS0NYVDM1WVdvTm8wbzExNy1SU0dqUGg3alN1NjFmLUhnYkx1dW0xVG1ueTRlcW5yX2hyU0hpY0w1d3gwODRCWDBRZjVTdEtkRUoydzY2ZUJqWHprRV9OIiwieSI6IkFIMEJfT2RaYTQtbG43dGJ4M3VBdlc1NDNQRE9HUXBCTDloRFFNWjlTQXNfOW05UWN3dnhRd1hrb1VrM3VzT1FnVV9ySVFrNFRoZ1NTUzV4UlhKcm5ZaTkifSwia2lkIjoiYmRvV3pLekpKUGw0TVFIaENDa05WYTZlZ1dmYi02V1haSjZKTFZqQ0hWMD0ifQ.HalyoHsfufBJEODd2lD9ThQvvVWw3b2kgWDLHGxmHhMv8rODyLL_Ug.rpQP178t8Ed_pUU2.Sn9UFeVoegAxiMUv11q7l3M0y9YHSLYi2n_JB7n7Pc777_47-icfaxstJemT0IC81w.akkq1EBxzWkBr4vEomSpWA",
67
- });
68
- if (res.ok) {
69
- const { value: result } = res;
70
- console.log(result);
71
- } else {
72
- console.log("endToEndEncryptionTestEncryptedToken failed:", res.error);
73
- }
74
- }
75
-
76
- run();
77
- ```
78
-
79
- ### Parameters
80
-
81
- | Parameter | Type | Required | Description |
82
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
83
- | `request` | [components.E2EEToken](../../models/components/e2eetoken.md) | :heavy_check_mark: | The request object to use for the request. |
84
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
85
- | `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. |
86
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
87
-
88
- ### Response
89
-
90
- **Promise\<[operations.TestEndToEndTokenResponse](../../models/operations/testendtoendtokenresponse.md)\>**
91
-
92
- ### Errors
93
-
94
- | Error Type | Status Code | Content Type |
95
- | ------------------- | ------------------- | ------------------- |
96
- | errors.GenericError | 400 | application/json |
97
- | errors.APIError | 4XX, 5XX | \*/\* |
98
-
99
- ## generateKey
100
-
101
- Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.
102
-
103
- ### Example Usage
104
-
105
- <!-- UsageSnippet language="typescript" operationID="generateEndToEndKey" method="post" path="/end-to-end-keys" -->
106
- ```typescript
107
- import { Moov } from "@moovio/sdk";
108
-
109
- const moov = new Moov({
110
- xMoovVersion: "v2024.01.00",
111
- security: {
112
- username: "",
113
- password: "",
114
- },
115
- });
116
-
117
- async function run() {
118
- const result = await moov.endToEndEncryption.generateKey({});
119
-
120
- console.log(result);
121
- }
122
-
123
- run();
124
- ```
125
-
126
- ### Standalone function
127
-
128
- The standalone function version of this method:
129
-
130
- ```typescript
131
- import { MoovCore } from "@moovio/sdk/core.js";
132
- import { endToEndEncryptionGenerateKey } from "@moovio/sdk/funcs/endToEndEncryptionGenerateKey.js";
133
-
134
- // Use `MoovCore` for best tree-shaking performance.
135
- // You can create one instance of it to use across an application.
136
- const moov = new MoovCore({
137
- xMoovVersion: "v2024.01.00",
138
- security: {
139
- username: "",
140
- password: "",
141
- },
142
- });
143
-
144
- async function run() {
145
- const res = await endToEndEncryptionGenerateKey(moov, {});
146
- if (res.ok) {
147
- const { value: result } = res;
148
- console.log(result);
149
- } else {
150
- console.log("endToEndEncryptionGenerateKey failed:", res.error);
151
- }
152
- }
153
-
154
- run();
155
- ```
156
-
157
- ### Parameters
158
-
159
- | Parameter | Type | Required | Description |
160
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
161
- | `request` | [operations.GenerateEndToEndKeyRequest](../../models/operations/generateendtoendkeyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
162
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
163
- | `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. |
164
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
165
-
166
- ### Response
167
-
168
- **Promise\<[operations.GenerateEndToEndKeyResponse](../../models/operations/generateendtoendkeyresponse.md)\>**
169
-
170
- ### Errors
171
-
172
- | Error Type | Status Code | Content Type |
173
- | --------------- | --------------- | --------------- |
174
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/enrichedaddress/README.md DELETED
@@ -1,95 +0,0 @@
1
- # EnrichedAddress
2
- (*enrichedAddress*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [get](#get) - Fetch enriched address suggestions. Requires a partial address.
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 `/profile-enrichment.read` scope.
12
-
13
- ## get
14
-
15
- Fetch enriched address suggestions. Requires a partial address.
16
-
17
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
18
- you'll need to specify the `/profile-enrichment.read` scope.
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="getEnrichmentAddress" method="get" path="/enrichment/address" -->
23
- ```typescript
24
- import { Moov } from "@moovio/sdk";
25
-
26
- const moov = new Moov({
27
- xMoovVersion: "v2024.01.00",
28
- security: {
29
- username: "",
30
- password: "",
31
- },
32
- });
33
-
34
- async function run() {
35
- const result = await moov.enrichedAddress.get({
36
- search: "<value>",
37
- });
38
-
39
- console.log(result);
40
- }
41
-
42
- run();
43
- ```
44
-
45
- ### Standalone function
46
-
47
- The standalone function version of this method:
48
-
49
- ```typescript
50
- import { MoovCore } from "@moovio/sdk/core.js";
51
- import { enrichedAddressGet } from "@moovio/sdk/funcs/enrichedAddressGet.js";
52
-
53
- // Use `MoovCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const moov = new MoovCore({
56
- xMoovVersion: "v2024.01.00",
57
- security: {
58
- username: "",
59
- password: "",
60
- },
61
- });
62
-
63
- async function run() {
64
- const res = await enrichedAddressGet(moov, {
65
- search: "<value>",
66
- });
67
- if (res.ok) {
68
- const { value: result } = res;
69
- console.log(result);
70
- } else {
71
- console.log("enrichedAddressGet failed:", res.error);
72
- }
73
- }
74
-
75
- run();
76
- ```
77
-
78
- ### Parameters
79
-
80
- | Parameter | Type | Required | Description |
81
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
82
- | `request` | [operations.GetEnrichmentAddressRequest](../../models/operations/getenrichmentaddressrequest.md) | :heavy_check_mark: | The request object to use for the request. |
83
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
84
- | `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. |
85
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
86
-
87
- ### Response
88
-
89
- **Promise\<[operations.GetEnrichmentAddressResponse](../../models/operations/getenrichmentaddressresponse.md)\>**
90
-
91
- ### Errors
92
-
93
- | Error Type | Status Code | Content Type |
94
- | --------------- | --------------- | --------------- |
95
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/enrichedprofile/README.md DELETED
@@ -1,95 +0,0 @@
1
- # EnrichedProfile
2
- (*enrichedProfile*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [get](#get) - Fetch enriched profile data. Requires a valid email address. This service is offered in collaboration with Clearbit.
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 `/profile-enrichment.read` scope.
12
-
13
- ## get
14
-
15
- Fetch enriched profile data. Requires a valid email address. This service is offered in collaboration with Clearbit.
16
-
17
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
18
- you'll need to specify the `/profile-enrichment.read` scope.
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="getEnrichmentProfile" method="get" path="/enrichment/profile" -->
23
- ```typescript
24
- import { Moov } from "@moovio/sdk";
25
-
26
- const moov = new Moov({
27
- xMoovVersion: "v2024.01.00",
28
- security: {
29
- username: "",
30
- password: "",
31
- },
32
- });
33
-
34
- async function run() {
35
- const result = await moov.enrichedProfile.get({
36
- email: "Thaddeus.Welch@gmail.com",
37
- });
38
-
39
- console.log(result);
40
- }
41
-
42
- run();
43
- ```
44
-
45
- ### Standalone function
46
-
47
- The standalone function version of this method:
48
-
49
- ```typescript
50
- import { MoovCore } from "@moovio/sdk/core.js";
51
- import { enrichedProfileGet } from "@moovio/sdk/funcs/enrichedProfileGet.js";
52
-
53
- // Use `MoovCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const moov = new MoovCore({
56
- xMoovVersion: "v2024.01.00",
57
- security: {
58
- username: "",
59
- password: "",
60
- },
61
- });
62
-
63
- async function run() {
64
- const res = await enrichedProfileGet(moov, {
65
- email: "Thaddeus.Welch@gmail.com",
66
- });
67
- if (res.ok) {
68
- const { value: result } = res;
69
- console.log(result);
70
- } else {
71
- console.log("enrichedProfileGet failed:", res.error);
72
- }
73
- }
74
-
75
- run();
76
- ```
77
-
78
- ### Parameters
79
-
80
- | Parameter | Type | Required | Description |
81
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
82
- | `request` | [operations.GetEnrichmentProfileRequest](../../models/operations/getenrichmentprofilerequest.md) | :heavy_check_mark: | The request object to use for the request. |
83
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
84
- | `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. |
85
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
86
-
87
- ### Response
88
-
89
- **Promise\<[operations.GetEnrichmentProfileResponse](../../models/operations/getenrichmentprofileresponse.md)\>**
90
-
91
- ### Errors
92
-
93
- | Error Type | Status Code | Content Type |
94
- | --------------- | --------------- | --------------- |
95
- | errors.APIError | 4XX, 5XX | \*/\* |