@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/branding/README.md DELETED
@@ -1,407 +0,0 @@
1
- # Branding
2
- (*branding*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Create brand properties for the specified 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}/branding.write` scope.
12
- * [upsert](#upsert) - Create or replace brand properties for the specified 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 `/accounts/{accountID}/branding.write` scope.
16
- * [get](#get) - Get brand properties for the specified account.
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 `/accounts/{accountID}/branding.read` scope.
20
- * [update](#update) - Updates the brand properties for the specified account.
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 `/accounts/{accountID}/branding.write` scope.
24
-
25
- ## create
26
-
27
- Create brand properties for the specified account.
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 `/accounts/{accountID}/branding.write` scope.
31
-
32
- ### Example Usage
33
-
34
- <!-- UsageSnippet language="typescript" operationID="createBrand" method="post" path="/accounts/{accountID}/branding" -->
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.branding.create({
48
- accountID: "0a6ae927-b52b-4ef4-86d0-288f27479817",
49
- brandProperties: {
50
- colors: {
51
- dark: {
52
- accent: "#111111",
53
- },
54
- light: {
55
- accent: "#111111",
56
- },
57
- },
58
- },
59
- });
60
-
61
- console.log(result);
62
- }
63
-
64
- run();
65
- ```
66
-
67
- ### Standalone function
68
-
69
- The standalone function version of this method:
70
-
71
- ```typescript
72
- import { MoovCore } from "@moovio/sdk/core.js";
73
- import { brandingCreate } from "@moovio/sdk/funcs/brandingCreate.js";
74
-
75
- // Use `MoovCore` for best tree-shaking performance.
76
- // You can create one instance of it to use across an application.
77
- const moov = new MoovCore({
78
- xMoovVersion: "v2024.01.00",
79
- security: {
80
- username: "",
81
- password: "",
82
- },
83
- });
84
-
85
- async function run() {
86
- const res = await brandingCreate(moov, {
87
- accountID: "0a6ae927-b52b-4ef4-86d0-288f27479817",
88
- brandProperties: {
89
- colors: {
90
- dark: {
91
- accent: "#111111",
92
- },
93
- light: {
94
- accent: "#111111",
95
- },
96
- },
97
- },
98
- });
99
- if (res.ok) {
100
- const { value: result } = res;
101
- console.log(result);
102
- } else {
103
- console.log("brandingCreate failed:", res.error);
104
- }
105
- }
106
-
107
- run();
108
- ```
109
-
110
- ### Parameters
111
-
112
- | Parameter | Type | Required | Description |
113
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
114
- | `request` | [operations.CreateBrandRequest](../../models/operations/createbrandrequest.md) | :heavy_check_mark: | The request object to use for the request. |
115
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
116
- | `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. |
117
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
118
-
119
- ### Response
120
-
121
- **Promise\<[operations.CreateBrandResponse](../../models/operations/createbrandresponse.md)\>**
122
-
123
- ### Errors
124
-
125
- | Error Type | Status Code | Content Type |
126
- | --------------------------- | --------------------------- | --------------------------- |
127
- | errors.GenericError | 400, 409 | application/json |
128
- | errors.BrandValidationError | 422 | application/json |
129
- | errors.APIError | 4XX, 5XX | \*/\* |
130
-
131
- ## upsert
132
-
133
- Create or replace brand properties for the specified account.
134
-
135
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
136
- you'll need to specify the `/accounts/{accountID}/branding.write` scope.
137
-
138
- ### Example Usage
139
-
140
- <!-- UsageSnippet language="typescript" operationID="upsertBrand" method="put" path="/accounts/{accountID}/branding" -->
141
- ```typescript
142
- import { Moov } from "@moovio/sdk";
143
-
144
- const moov = new Moov({
145
- xMoovVersion: "v2024.01.00",
146
- security: {
147
- username: "",
148
- password: "",
149
- },
150
- });
151
-
152
- async function run() {
153
- const result = await moov.branding.upsert({
154
- accountID: "0cd408b1-a57d-477b-825b-12331c2ed00a",
155
- brandProperties: {
156
- colors: {
157
- dark: {
158
- accent: "#111111",
159
- },
160
- light: {
161
- accent: "#111111",
162
- },
163
- },
164
- },
165
- });
166
-
167
- console.log(result);
168
- }
169
-
170
- run();
171
- ```
172
-
173
- ### Standalone function
174
-
175
- The standalone function version of this method:
176
-
177
- ```typescript
178
- import { MoovCore } from "@moovio/sdk/core.js";
179
- import { brandingUpsert } from "@moovio/sdk/funcs/brandingUpsert.js";
180
-
181
- // Use `MoovCore` for best tree-shaking performance.
182
- // You can create one instance of it to use across an application.
183
- const moov = new MoovCore({
184
- xMoovVersion: "v2024.01.00",
185
- security: {
186
- username: "",
187
- password: "",
188
- },
189
- });
190
-
191
- async function run() {
192
- const res = await brandingUpsert(moov, {
193
- accountID: "0cd408b1-a57d-477b-825b-12331c2ed00a",
194
- brandProperties: {
195
- colors: {
196
- dark: {
197
- accent: "#111111",
198
- },
199
- light: {
200
- accent: "#111111",
201
- },
202
- },
203
- },
204
- });
205
- if (res.ok) {
206
- const { value: result } = res;
207
- console.log(result);
208
- } else {
209
- console.log("brandingUpsert failed:", res.error);
210
- }
211
- }
212
-
213
- run();
214
- ```
215
-
216
- ### Parameters
217
-
218
- | Parameter | Type | Required | Description |
219
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
220
- | `request` | [operations.UpsertBrandRequest](../../models/operations/upsertbrandrequest.md) | :heavy_check_mark: | The request object to use for the request. |
221
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
222
- | `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. |
223
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
224
-
225
- ### Response
226
-
227
- **Promise\<[operations.UpsertBrandResponse](../../models/operations/upsertbrandresponse.md)\>**
228
-
229
- ### Errors
230
-
231
- | Error Type | Status Code | Content Type |
232
- | --------------------------- | --------------------------- | --------------------------- |
233
- | errors.GenericError | 400, 409 | application/json |
234
- | errors.BrandValidationError | 422 | application/json |
235
- | errors.APIError | 4XX, 5XX | \*/\* |
236
-
237
- ## get
238
-
239
- Get brand properties for the specified account.
240
-
241
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
242
- you'll need to specify the `/accounts/{accountID}/branding.read` scope.
243
-
244
- ### Example Usage
245
-
246
- <!-- UsageSnippet language="typescript" operationID="getBrand" method="get" path="/accounts/{accountID}/branding" -->
247
- ```typescript
248
- import { Moov } from "@moovio/sdk";
249
-
250
- const moov = new Moov({
251
- xMoovVersion: "v2024.01.00",
252
- security: {
253
- username: "",
254
- password: "",
255
- },
256
- });
257
-
258
- async function run() {
259
- const result = await moov.branding.get({
260
- accountID: "8a4ec43e-d45f-481d-a291-683cb221e3cc",
261
- });
262
-
263
- console.log(result);
264
- }
265
-
266
- run();
267
- ```
268
-
269
- ### Standalone function
270
-
271
- The standalone function version of this method:
272
-
273
- ```typescript
274
- import { MoovCore } from "@moovio/sdk/core.js";
275
- import { brandingGet } from "@moovio/sdk/funcs/brandingGet.js";
276
-
277
- // Use `MoovCore` for best tree-shaking performance.
278
- // You can create one instance of it to use across an application.
279
- const moov = new MoovCore({
280
- xMoovVersion: "v2024.01.00",
281
- security: {
282
- username: "",
283
- password: "",
284
- },
285
- });
286
-
287
- async function run() {
288
- const res = await brandingGet(moov, {
289
- accountID: "8a4ec43e-d45f-481d-a291-683cb221e3cc",
290
- });
291
- if (res.ok) {
292
- const { value: result } = res;
293
- console.log(result);
294
- } else {
295
- console.log("brandingGet failed:", res.error);
296
- }
297
- }
298
-
299
- run();
300
- ```
301
-
302
- ### Parameters
303
-
304
- | Parameter | Type | Required | Description |
305
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
306
- | `request` | [operations.GetBrandRequest](../../models/operations/getbrandrequest.md) | :heavy_check_mark: | The request object to use for the request. |
307
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
308
- | `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. |
309
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
310
-
311
- ### Response
312
-
313
- **Promise\<[operations.GetBrandResponse](../../models/operations/getbrandresponse.md)\>**
314
-
315
- ### Errors
316
-
317
- | Error Type | Status Code | Content Type |
318
- | --------------- | --------------- | --------------- |
319
- | errors.APIError | 4XX, 5XX | \*/\* |
320
-
321
- ## update
322
-
323
- Updates the brand properties for the specified account.
324
-
325
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
326
- you'll need to specify the `/accounts/{accountID}/branding.write` scope.
327
-
328
- ### Example Usage
329
-
330
- <!-- UsageSnippet language="typescript" operationID="updateBrand" method="patch" path="/accounts/{accountID}/branding" -->
331
- ```typescript
332
- import { Moov } from "@moovio/sdk";
333
-
334
- const moov = new Moov({
335
- xMoovVersion: "v2024.01.00",
336
- security: {
337
- username: "",
338
- password: "",
339
- },
340
- });
341
-
342
- async function run() {
343
- const result = await moov.branding.update({
344
- accountID: "0c0dc4a5-ecd9-4223-810a-a71632980156",
345
- updateBrand: {},
346
- });
347
-
348
- console.log(result);
349
- }
350
-
351
- run();
352
- ```
353
-
354
- ### Standalone function
355
-
356
- The standalone function version of this method:
357
-
358
- ```typescript
359
- import { MoovCore } from "@moovio/sdk/core.js";
360
- import { brandingUpdate } from "@moovio/sdk/funcs/brandingUpdate.js";
361
-
362
- // Use `MoovCore` for best tree-shaking performance.
363
- // You can create one instance of it to use across an application.
364
- const moov = new MoovCore({
365
- xMoovVersion: "v2024.01.00",
366
- security: {
367
- username: "",
368
- password: "",
369
- },
370
- });
371
-
372
- async function run() {
373
- const res = await brandingUpdate(moov, {
374
- accountID: "0c0dc4a5-ecd9-4223-810a-a71632980156",
375
- updateBrand: {},
376
- });
377
- if (res.ok) {
378
- const { value: result } = res;
379
- console.log(result);
380
- } else {
381
- console.log("brandingUpdate failed:", res.error);
382
- }
383
- }
384
-
385
- run();
386
- ```
387
-
388
- ### Parameters
389
-
390
- | Parameter | Type | Required | Description |
391
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
392
- | `request` | [operations.UpdateBrandRequest](../../models/operations/updatebrandrequest.md) | :heavy_check_mark: | The request object to use for the request. |
393
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
394
- | `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. |
395
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
396
-
397
- ### Response
398
-
399
- **Promise\<[operations.UpdateBrandResponse](../../models/operations/updatebrandresponse.md)\>**
400
-
401
- ### Errors
402
-
403
- | Error Type | Status Code | Content Type |
404
- | --------------------------- | --------------------------- | --------------------------- |
405
- | errors.GenericError | 400, 409 | application/json |
406
- | errors.BrandValidationError | 422 | application/json |
407
- | errors.APIError | 4XX, 5XX | \*/\* |