@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/paymentmethods/README.md DELETED
@@ -1,187 +0,0 @@
1
- # PaymentMethods
2
- (*paymentMethods*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Retrieve a list of payment methods associated with a Moov account. Read our [payment methods
9
- guide](https://docs.moov.io/guides/money-movement/payment-methods/) to learn more.
10
-
11
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
12
- you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
13
- * [get](#get) - Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) to learn more.
14
-
15
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
16
- you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
17
-
18
- ## list
19
-
20
- Retrieve a list of payment methods associated with a Moov account. Read our [payment methods
21
- guide](https://docs.moov.io/guides/money-movement/payment-methods/) to learn more.
22
-
23
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
24
- you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
25
-
26
- ### Example Usage
27
-
28
- <!-- UsageSnippet language="typescript" operationID="listPaymentMethods" method="get" path="/accounts/{accountID}/payment-methods" -->
29
- ```typescript
30
- import { Moov } from "@moovio/sdk";
31
-
32
- const moov = new Moov({
33
- xMoovVersion: "v2024.01.00",
34
- security: {
35
- username: "",
36
- password: "",
37
- },
38
- });
39
-
40
- async function run() {
41
- const result = await moov.paymentMethods.list({
42
- accountID: "f5503781-dfe4-4bcd-9487-5b5fe2b4d53b",
43
- });
44
-
45
- console.log(result);
46
- }
47
-
48
- run();
49
- ```
50
-
51
- ### Standalone function
52
-
53
- The standalone function version of this method:
54
-
55
- ```typescript
56
- import { MoovCore } from "@moovio/sdk/core.js";
57
- import { paymentMethodsList } from "@moovio/sdk/funcs/paymentMethodsList.js";
58
-
59
- // Use `MoovCore` for best tree-shaking performance.
60
- // You can create one instance of it to use across an application.
61
- const moov = new MoovCore({
62
- xMoovVersion: "v2024.01.00",
63
- security: {
64
- username: "",
65
- password: "",
66
- },
67
- });
68
-
69
- async function run() {
70
- const res = await paymentMethodsList(moov, {
71
- accountID: "f5503781-dfe4-4bcd-9487-5b5fe2b4d53b",
72
- });
73
- if (res.ok) {
74
- const { value: result } = res;
75
- console.log(result);
76
- } else {
77
- console.log("paymentMethodsList failed:", res.error);
78
- }
79
- }
80
-
81
- run();
82
- ```
83
-
84
- ### Parameters
85
-
86
- | Parameter | Type | Required | Description |
87
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
88
- | `request` | [operations.ListPaymentMethodsRequest](../../models/operations/listpaymentmethodsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
89
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
90
- | `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. |
91
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
92
-
93
- ### Response
94
-
95
- **Promise\<[operations.ListPaymentMethodsResponse](../../models/operations/listpaymentmethodsresponse.md)\>**
96
-
97
- ### Errors
98
-
99
- | Error Type | Status Code | Content Type |
100
- | --------------- | --------------- | --------------- |
101
- | errors.APIError | 4XX, 5XX | \*/\* |
102
-
103
- ## get
104
-
105
- Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) to learn more.
106
-
107
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
108
- you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
109
-
110
- ### Example Usage
111
-
112
- <!-- UsageSnippet language="typescript" operationID="getPaymentMethod" method="get" path="/accounts/{accountID}/payment-methods/{paymentMethodID}" -->
113
- ```typescript
114
- import { Moov } from "@moovio/sdk";
115
-
116
- const moov = new Moov({
117
- xMoovVersion: "v2024.01.00",
118
- security: {
119
- username: "",
120
- password: "",
121
- },
122
- });
123
-
124
- async function run() {
125
- const result = await moov.paymentMethods.get({
126
- accountID: "56878537-30b0-48ee-9c54-07ab3a8b243d",
127
- paymentMethodID: "aa740bf3-4c5f-459b-9370-4f7d4bea382b",
128
- });
129
-
130
- console.log(result);
131
- }
132
-
133
- run();
134
- ```
135
-
136
- ### Standalone function
137
-
138
- The standalone function version of this method:
139
-
140
- ```typescript
141
- import { MoovCore } from "@moovio/sdk/core.js";
142
- import { paymentMethodsGet } from "@moovio/sdk/funcs/paymentMethodsGet.js";
143
-
144
- // Use `MoovCore` for best tree-shaking performance.
145
- // You can create one instance of it to use across an application.
146
- const moov = new MoovCore({
147
- xMoovVersion: "v2024.01.00",
148
- security: {
149
- username: "",
150
- password: "",
151
- },
152
- });
153
-
154
- async function run() {
155
- const res = await paymentMethodsGet(moov, {
156
- accountID: "56878537-30b0-48ee-9c54-07ab3a8b243d",
157
- paymentMethodID: "aa740bf3-4c5f-459b-9370-4f7d4bea382b",
158
- });
159
- if (res.ok) {
160
- const { value: result } = res;
161
- console.log(result);
162
- } else {
163
- console.log("paymentMethodsGet failed:", res.error);
164
- }
165
- }
166
-
167
- run();
168
- ```
169
-
170
- ### Parameters
171
-
172
- | Parameter | Type | Required | Description |
173
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
174
- | `request` | [operations.GetPaymentMethodRequest](../../models/operations/getpaymentmethodrequest.md) | :heavy_check_mark: | The request object to use for the request. |
175
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
176
- | `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. |
177
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
178
-
179
- ### Response
180
-
181
- **Promise\<[operations.GetPaymentMethodResponse](../../models/operations/getpaymentmethodresponse.md)\>**
182
-
183
- ### Errors
184
-
185
- | Error Type | Status Code | Content Type |
186
- | --------------- | --------------- | --------------- |
187
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/ping/README.md DELETED
@@ -1,91 +0,0 @@
1
- # Ping
2
- (*ping*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [ping](#ping) - A simple endpoint to check auth.
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
-
13
- ## ping
14
-
15
- A simple endpoint to check auth.
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 `/ping.read` scope.
19
-
20
- ### Example Usage
21
-
22
- <!-- UsageSnippet language="typescript" operationID="ping" method="get" path="/ping" -->
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.ping.ping({});
36
-
37
- console.log(result);
38
- }
39
-
40
- run();
41
- ```
42
-
43
- ### Standalone function
44
-
45
- The standalone function version of this method:
46
-
47
- ```typescript
48
- import { MoovCore } from "@moovio/sdk/core.js";
49
- import { pingPing } from "@moovio/sdk/funcs/pingPing.js";
50
-
51
- // Use `MoovCore` for best tree-shaking performance.
52
- // You can create one instance of it to use across an application.
53
- const moov = new MoovCore({
54
- xMoovVersion: "v2024.01.00",
55
- security: {
56
- username: "",
57
- password: "",
58
- },
59
- });
60
-
61
- async function run() {
62
- const res = await pingPing(moov, {});
63
- if (res.ok) {
64
- const { value: result } = res;
65
- console.log(result);
66
- } else {
67
- console.log("pingPing failed:", res.error);
68
- }
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Parameters
75
-
76
- | Parameter | Type | Required | Description |
77
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
- | `request` | [operations.PingRequest](../../models/operations/pingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
79
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
80
- | `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. |
81
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
82
-
83
- ### Response
84
-
85
- **Promise\<[operations.PingResponse](../../models/operations/pingresponse.md)\>**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | --------------- | --------------- | --------------- |
91
- | errors.APIError | 4XX, 5XX | \*/\* |