@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/industries/README.md DELETED
@@ -1,91 +0,0 @@
1
- # Industries
2
- (*industries*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Returns a list of industries relevant to merchant profile enrichment. Results are ordered by industry name.
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
- ## list
14
-
15
- Returns a list of industries relevant to merchant profile enrichment. Results are ordered by industry name.
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="listIndustries" method="get" path="/industries" -->
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.industries.list({});
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 { industriesList } from "@moovio/sdk/funcs/industriesList.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 industriesList(moov, {});
63
- if (res.ok) {
64
- const { value: result } = res;
65
- console.log(result);
66
- } else {
67
- console.log("industriesList failed:", res.error);
68
- }
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Parameters
75
-
76
- | Parameter | Type | Required | Description |
77
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
- | `request` | [operations.ListIndustriesRequest](../../models/operations/listindustriesrequest.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.ListIndustriesResponse](../../models/operations/listindustriesresponse.md)\>**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | --------------- | --------------- | --------------- |
91
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/institutions/README.md DELETED
@@ -1,184 +0,0 @@
1
- # Institutions
2
- (*institutions*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [searchInstitutions](#searchinstitutions) - Search for financial institutions by name or routing number.
9
-
10
- This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).
11
-
12
- This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.
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 `/institutions.read` scope.
16
- * [search](#search) - Search for institutions by either their name or routing number.
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 `/fed.read` scope.
20
-
21
- ## searchInstitutions
22
-
23
- Search for financial institutions by name or routing number.
24
-
25
- This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).
26
-
27
- This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.
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 `/institutions.read` scope.
31
-
32
- ### Example Usage
33
-
34
- <!-- UsageSnippet language="typescript" operationID="searchInstitutions" method="get" path="/institutions" -->
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.institutions.searchInstitutions({});
48
-
49
- console.log(result);
50
- }
51
-
52
- run();
53
- ```
54
-
55
- ### Standalone function
56
-
57
- The standalone function version of this method:
58
-
59
- ```typescript
60
- import { MoovCore } from "@moovio/sdk/core.js";
61
- import { institutionsSearchInstitutions } from "@moovio/sdk/funcs/institutionsSearchInstitutions.js";
62
-
63
- // Use `MoovCore` for best tree-shaking performance.
64
- // You can create one instance of it to use across an application.
65
- const moov = new MoovCore({
66
- xMoovVersion: "v2024.01.00",
67
- security: {
68
- username: "",
69
- password: "",
70
- },
71
- });
72
-
73
- async function run() {
74
- const res = await institutionsSearchInstitutions(moov, {});
75
- if (res.ok) {
76
- const { value: result } = res;
77
- console.log(result);
78
- } else {
79
- console.log("institutionsSearchInstitutions failed:", res.error);
80
- }
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Parameters
87
-
88
- | Parameter | Type | Required | Description |
89
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
- | `request` | [operations.SearchInstitutionsRequest](../../models/operations/searchinstitutionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
91
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
92
- | `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. |
93
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
94
-
95
- ### Response
96
-
97
- **Promise\<[operations.SearchInstitutionsResponse](../../models/operations/searchinstitutionsresponse.md)\>**
98
-
99
- ### Errors
100
-
101
- | Error Type | Status Code | Content Type |
102
- | --------------- | --------------- | --------------- |
103
- | errors.APIError | 4XX, 5XX | \*/\* |
104
-
105
- ## search
106
-
107
- Search for institutions by either their name or routing number.
108
-
109
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
110
- you'll need to specify the `/fed.read` scope.
111
-
112
- ### Example Usage
113
-
114
- <!-- UsageSnippet language="typescript" operationID="listInstitutions" method="get" path="/institutions/ach/search" -->
115
- ```typescript
116
- import { Moov } from "@moovio/sdk";
117
-
118
- const moov = new Moov({
119
- xMoovVersion: "v2024.01.00",
120
- security: {
121
- username: "",
122
- password: "",
123
- },
124
- });
125
-
126
- async function run() {
127
- const result = await moov.institutions.search({});
128
-
129
- console.log(result);
130
- }
131
-
132
- run();
133
- ```
134
-
135
- ### Standalone function
136
-
137
- The standalone function version of this method:
138
-
139
- ```typescript
140
- import { MoovCore } from "@moovio/sdk/core.js";
141
- import { institutionsSearch } from "@moovio/sdk/funcs/institutionsSearch.js";
142
-
143
- // Use `MoovCore` for best tree-shaking performance.
144
- // You can create one instance of it to use across an application.
145
- const moov = new MoovCore({
146
- xMoovVersion: "v2024.01.00",
147
- security: {
148
- username: "",
149
- password: "",
150
- },
151
- });
152
-
153
- async function run() {
154
- const res = await institutionsSearch(moov, {});
155
- if (res.ok) {
156
- const { value: result } = res;
157
- console.log(result);
158
- } else {
159
- console.log("institutionsSearch failed:", res.error);
160
- }
161
- }
162
-
163
- run();
164
- ```
165
-
166
- ### Parameters
167
-
168
- | Parameter | Type | Required | Description |
169
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
170
- | `request` | [operations.ListInstitutionsRequest](../../models/operations/listinstitutionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
171
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
172
- | `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. |
173
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
174
-
175
- ### Response
176
-
177
- **Promise\<[operations.ListInstitutionsResponse](../../models/operations/listinstitutionsresponse.md)\>**
178
-
179
- ### Errors
180
-
181
- | Error Type | Status Code | Content Type |
182
- | ------------------- | ------------------- | ------------------- |
183
- | errors.GenericError | 400 | application/json |
184
- | errors.APIError | 4XX, 5XX | \*/\* |