@moovio/sdk 0.21.1 → 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 +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/statements/README.md DELETED
@@ -1,194 +0,0 @@
1
- # Statements
2
- (*statements*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - Retrieve all statements associated with an account.
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/{accountID}/profile.read` scope.
12
- * [get](#get) - Retrieve a statement by its ID.
13
-
14
- Use the `Accept` header to specify the format of the response. Supported formats are `application/json` and `application/pdf`.
15
-
16
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
17
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
18
-
19
- ## list
20
-
21
- Retrieve all statements associated with an account.
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}/profile.read` scope.
25
-
26
- ### Example Usage
27
-
28
- <!-- UsageSnippet language="typescript" operationID="listStatements" method="get" path="/accounts/{accountID}/statements" -->
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.statements.list({
42
- skip: 60,
43
- count: 20,
44
- accountID: "b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f",
45
- });
46
-
47
- console.log(result);
48
- }
49
-
50
- run();
51
- ```
52
-
53
- ### Standalone function
54
-
55
- The standalone function version of this method:
56
-
57
- ```typescript
58
- import { MoovCore } from "@moovio/sdk/core.js";
59
- import { statementsList } from "@moovio/sdk/funcs/statementsList.js";
60
-
61
- // Use `MoovCore` for best tree-shaking performance.
62
- // You can create one instance of it to use across an application.
63
- const moov = new MoovCore({
64
- xMoovVersion: "v2024.01.00",
65
- security: {
66
- username: "",
67
- password: "",
68
- },
69
- });
70
-
71
- async function run() {
72
- const res = await statementsList(moov, {
73
- skip: 60,
74
- count: 20,
75
- accountID: "b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f",
76
- });
77
- if (res.ok) {
78
- const { value: result } = res;
79
- console.log(result);
80
- } else {
81
- console.log("statementsList failed:", res.error);
82
- }
83
- }
84
-
85
- run();
86
- ```
87
-
88
- ### Parameters
89
-
90
- | Parameter | Type | Required | Description |
91
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
92
- | `request` | [operations.ListStatementsRequest](../../models/operations/liststatementsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
93
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
94
- | `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. |
95
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
96
-
97
- ### Response
98
-
99
- **Promise\<[operations.ListStatementsResponse](../../models/operations/liststatementsresponse.md)\>**
100
-
101
- ### Errors
102
-
103
- | Error Type | Status Code | Content Type |
104
- | ------------------- | ------------------- | ------------------- |
105
- | errors.GenericError | 400 | application/json |
106
- | errors.APIError | 4XX, 5XX | \*/\* |
107
-
108
- ## get
109
-
110
- Retrieve a statement by its ID.
111
-
112
- Use the `Accept` header to specify the format of the response. Supported formats are `application/json` and `application/pdf`.
113
-
114
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
115
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
116
-
117
- ### Example Usage
118
-
119
- <!-- UsageSnippet language="typescript" operationID="getStatement" method="get" path="/accounts/{accountID}/statements/{statementID}" -->
120
- ```typescript
121
- import { Moov } from "@moovio/sdk";
122
-
123
- const moov = new Moov({
124
- xMoovVersion: "v2024.01.00",
125
- security: {
126
- username: "",
127
- password: "",
128
- },
129
- });
130
-
131
- async function run() {
132
- const result = await moov.statements.get({
133
- accountID: "5623ff52-0b05-41ea-b7b3-655835064007",
134
- statementID: "9d45acbf-c4fe-4843-846c-eaa43c9ca17f",
135
- });
136
-
137
- console.log(result);
138
- }
139
-
140
- run();
141
- ```
142
-
143
- ### Standalone function
144
-
145
- The standalone function version of this method:
146
-
147
- ```typescript
148
- import { MoovCore } from "@moovio/sdk/core.js";
149
- import { statementsGet } from "@moovio/sdk/funcs/statementsGet.js";
150
-
151
- // Use `MoovCore` for best tree-shaking performance.
152
- // You can create one instance of it to use across an application.
153
- const moov = new MoovCore({
154
- xMoovVersion: "v2024.01.00",
155
- security: {
156
- username: "",
157
- password: "",
158
- },
159
- });
160
-
161
- async function run() {
162
- const res = await statementsGet(moov, {
163
- accountID: "5623ff52-0b05-41ea-b7b3-655835064007",
164
- statementID: "9d45acbf-c4fe-4843-846c-eaa43c9ca17f",
165
- });
166
- if (res.ok) {
167
- const { value: result } = res;
168
- console.log(result);
169
- } else {
170
- console.log("statementsGet failed:", res.error);
171
- }
172
- }
173
-
174
- run();
175
- ```
176
-
177
- ### Parameters
178
-
179
- | Parameter | Type | Required | Description |
180
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
181
- | `request` | [operations.GetStatementRequest](../../models/operations/getstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. |
182
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
183
- | `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. |
184
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
185
-
186
- ### Response
187
-
188
- **Promise\<[operations.GetStatementResponse](../../models/operations/getstatementresponse.md)\>**
189
-
190
- ### Errors
191
-
192
- | Error Type | Status Code | Content Type |
193
- | --------------- | --------------- | --------------- |
194
- | errors.APIError | 4XX, 5XX | \*/\* |