@moovio/sdk 0.21.1 → 0.21.4

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/feeplans/README.md DELETED
@@ -1,921 +0,0 @@
1
- # FeePlans
2
- (*feePlans*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [listFeePlanAgreements](#listfeeplanagreements) - List all fee plan agreements 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
- * [createFeePlanAgreements](#createfeeplanagreements) - Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.
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}/profile.write` scope.
16
- * [listFeePlans](#listfeeplans) - List all fee plans available for use by an account. This is intended to be used by an account when
17
- selecting a fee plan to apply to a connected account.
18
-
19
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
20
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
21
- * [retrieveFees](#retrievefees) - Retrieve fees 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}/transfers.read` scope.
25
- * [listFeesFetch](#listfeesfetch) - List fees associated with an account.
26
-
27
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
28
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
29
- * [listPartnerPricing](#listpartnerpricing) - List all partner pricing plans available for use by an account.
30
-
31
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
32
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
33
- * [listPartnerPricingAgreements](#listpartnerpricingagreements) - List all partner pricing agreements associated with an account.
34
-
35
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
36
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
37
- * [listResiduals](#listresiduals) - List all residuals associated with an account.
38
-
39
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
40
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
41
- * [getResidual](#getresidual) - Get a residual associated with an account.
42
-
43
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
44
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
45
- * [listResidualFees](#listresidualfees) - List all fees associated with a residual.
46
-
47
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
48
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
49
-
50
- ## listFeePlanAgreements
51
-
52
- List all fee plan agreements associated with an account.
53
-
54
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
55
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
56
-
57
- ### Example Usage
58
-
59
- <!-- UsageSnippet language="typescript" operationID="listFeePlanAgreements" method="get" path="/accounts/{accountID}/fee-plan-agreements" -->
60
- ```typescript
61
- import { Moov } from "@moovio/sdk";
62
-
63
- const moov = new Moov({
64
- xMoovVersion: "v2024.01.00",
65
- security: {
66
- username: "",
67
- password: "",
68
- },
69
- });
70
-
71
- async function run() {
72
- const result = await moov.feePlans.listFeePlanAgreements({
73
- skip: 60,
74
- count: 20,
75
- accountID: "93c43634-5477-42a7-972d-01fa76a09e17",
76
- });
77
-
78
- console.log(result);
79
- }
80
-
81
- run();
82
- ```
83
-
84
- ### Standalone function
85
-
86
- The standalone function version of this method:
87
-
88
- ```typescript
89
- import { MoovCore } from "@moovio/sdk/core.js";
90
- import { feePlansListFeePlanAgreements } from "@moovio/sdk/funcs/feePlansListFeePlanAgreements.js";
91
-
92
- // Use `MoovCore` for best tree-shaking performance.
93
- // You can create one instance of it to use across an application.
94
- const moov = new MoovCore({
95
- xMoovVersion: "v2024.01.00",
96
- security: {
97
- username: "",
98
- password: "",
99
- },
100
- });
101
-
102
- async function run() {
103
- const res = await feePlansListFeePlanAgreements(moov, {
104
- skip: 60,
105
- count: 20,
106
- accountID: "93c43634-5477-42a7-972d-01fa76a09e17",
107
- });
108
- if (res.ok) {
109
- const { value: result } = res;
110
- console.log(result);
111
- } else {
112
- console.log("feePlansListFeePlanAgreements failed:", res.error);
113
- }
114
- }
115
-
116
- run();
117
- ```
118
-
119
- ### Parameters
120
-
121
- | Parameter | Type | Required | Description |
122
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
123
- | `request` | [operations.ListFeePlanAgreementsRequest](../../models/operations/listfeeplanagreementsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
124
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
125
- | `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. |
126
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
127
-
128
- ### Response
129
-
130
- **Promise\<[operations.ListFeePlanAgreementsResponse](../../models/operations/listfeeplanagreementsresponse.md)\>**
131
-
132
- ### Errors
133
-
134
- | Error Type | Status Code | Content Type |
135
- | --------------- | --------------- | --------------- |
136
- | errors.APIError | 4XX, 5XX | \*/\* |
137
-
138
- ## createFeePlanAgreements
139
-
140
- Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.
141
-
142
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
143
- you'll need to specify the `/accounts/{accountID}/profile.write` scope.
144
-
145
- ### Example Usage
146
-
147
- <!-- UsageSnippet language="typescript" operationID="createFeePlanAgreements" method="post" path="/accounts/{accountID}/fee-plan-agreements" -->
148
- ```typescript
149
- import { Moov } from "@moovio/sdk";
150
-
151
- const moov = new Moov({
152
- xMoovVersion: "v2024.01.00",
153
- security: {
154
- username: "",
155
- password: "",
156
- },
157
- });
158
-
159
- async function run() {
160
- const result = await moov.feePlans.createFeePlanAgreements({
161
- accountID: "409c6b4b-e622-40c2-9dc4-fb494e555723",
162
- createFeePlanAgreement: {
163
- planID: "19801f96-ea27-4610-b4d1-8c6b46f37928",
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 { feePlansCreateFeePlanAgreements } from "@moovio/sdk/funcs/feePlansCreateFeePlanAgreements.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 feePlansCreateFeePlanAgreements(moov, {
193
- accountID: "409c6b4b-e622-40c2-9dc4-fb494e555723",
194
- createFeePlanAgreement: {
195
- planID: "19801f96-ea27-4610-b4d1-8c6b46f37928",
196
- },
197
- });
198
- if (res.ok) {
199
- const { value: result } = res;
200
- console.log(result);
201
- } else {
202
- console.log("feePlansCreateFeePlanAgreements failed:", res.error);
203
- }
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Parameters
210
-
211
- | Parameter | Type | Required | Description |
212
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
213
- | `request` | [operations.CreateFeePlanAgreementsRequest](../../models/operations/createfeeplanagreementsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
214
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
215
- | `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. |
216
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
217
-
218
- ### Response
219
-
220
- **Promise\<[operations.CreateFeePlanAgreementsResponse](../../models/operations/createfeeplanagreementsresponse.md)\>**
221
-
222
- ### Errors
223
-
224
- | Error Type | Status Code | Content Type |
225
- | ---------------------------- | ---------------------------- | ---------------------------- |
226
- | errors.GenericError | 400, 409 | application/json |
227
- | errors.FeePlanAgreementError | 422 | application/json |
228
- | errors.APIError | 4XX, 5XX | \*/\* |
229
-
230
- ## listFeePlans
231
-
232
- List all fee plans available for use by an account. This is intended to be used by an account when
233
- selecting a fee plan to apply to a connected account.
234
-
235
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
236
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
237
-
238
- ### Example Usage
239
-
240
- <!-- UsageSnippet language="typescript" operationID="listFeePlans" method="get" path="/accounts/{accountID}/fee-plans" -->
241
- ```typescript
242
- import { Moov } from "@moovio/sdk";
243
-
244
- const moov = new Moov({
245
- xMoovVersion: "v2024.01.00",
246
- security: {
247
- username: "",
248
- password: "",
249
- },
250
- });
251
-
252
- async function run() {
253
- const result = await moov.feePlans.listFeePlans({
254
- accountID: "b3d59179-f74e-4ee8-b123-33220b3c7d4b",
255
- });
256
-
257
- console.log(result);
258
- }
259
-
260
- run();
261
- ```
262
-
263
- ### Standalone function
264
-
265
- The standalone function version of this method:
266
-
267
- ```typescript
268
- import { MoovCore } from "@moovio/sdk/core.js";
269
- import { feePlansListFeePlans } from "@moovio/sdk/funcs/feePlansListFeePlans.js";
270
-
271
- // Use `MoovCore` for best tree-shaking performance.
272
- // You can create one instance of it to use across an application.
273
- const moov = new MoovCore({
274
- xMoovVersion: "v2024.01.00",
275
- security: {
276
- username: "",
277
- password: "",
278
- },
279
- });
280
-
281
- async function run() {
282
- const res = await feePlansListFeePlans(moov, {
283
- accountID: "b3d59179-f74e-4ee8-b123-33220b3c7d4b",
284
- });
285
- if (res.ok) {
286
- const { value: result } = res;
287
- console.log(result);
288
- } else {
289
- console.log("feePlansListFeePlans failed:", res.error);
290
- }
291
- }
292
-
293
- run();
294
- ```
295
-
296
- ### Parameters
297
-
298
- | Parameter | Type | Required | Description |
299
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
300
- | `request` | [operations.ListFeePlansRequest](../../models/operations/listfeeplansrequest.md) | :heavy_check_mark: | The request object to use for the request. |
301
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
302
- | `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. |
303
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
304
-
305
- ### Response
306
-
307
- **Promise\<[operations.ListFeePlansResponse](../../models/operations/listfeeplansresponse.md)\>**
308
-
309
- ### Errors
310
-
311
- | Error Type | Status Code | Content Type |
312
- | --------------- | --------------- | --------------- |
313
- | errors.APIError | 4XX, 5XX | \*/\* |
314
-
315
- ## retrieveFees
316
-
317
- Retrieve fees associated with an account.
318
-
319
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
320
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
321
-
322
- ### Example Usage
323
-
324
- <!-- UsageSnippet language="typescript" operationID="retrieveFees" method="get" path="/accounts/{accountID}/fees" -->
325
- ```typescript
326
- import { Moov } from "@moovio/sdk";
327
-
328
- const moov = new Moov({
329
- xMoovVersion: "v2024.01.00",
330
- security: {
331
- username: "",
332
- password: "",
333
- },
334
- });
335
-
336
- async function run() {
337
- const result = await moov.feePlans.retrieveFees({
338
- accountID: "89daf02d-b6b3-4fbf-b20d-5bf967324682",
339
- skip: 60,
340
- count: 20,
341
- });
342
-
343
- console.log(result);
344
- }
345
-
346
- run();
347
- ```
348
-
349
- ### Standalone function
350
-
351
- The standalone function version of this method:
352
-
353
- ```typescript
354
- import { MoovCore } from "@moovio/sdk/core.js";
355
- import { feePlansRetrieveFees } from "@moovio/sdk/funcs/feePlansRetrieveFees.js";
356
-
357
- // Use `MoovCore` for best tree-shaking performance.
358
- // You can create one instance of it to use across an application.
359
- const moov = new MoovCore({
360
- xMoovVersion: "v2024.01.00",
361
- security: {
362
- username: "",
363
- password: "",
364
- },
365
- });
366
-
367
- async function run() {
368
- const res = await feePlansRetrieveFees(moov, {
369
- accountID: "89daf02d-b6b3-4fbf-b20d-5bf967324682",
370
- skip: 60,
371
- count: 20,
372
- });
373
- if (res.ok) {
374
- const { value: result } = res;
375
- console.log(result);
376
- } else {
377
- console.log("feePlansRetrieveFees failed:", res.error);
378
- }
379
- }
380
-
381
- run();
382
- ```
383
-
384
- ### Parameters
385
-
386
- | Parameter | Type | Required | Description |
387
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
388
- | `request` | [operations.RetrieveFeesRequest](../../models/operations/retrievefeesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
389
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
390
- | `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. |
391
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
392
-
393
- ### Response
394
-
395
- **Promise\<[operations.RetrieveFeesResponse](../../models/operations/retrievefeesresponse.md)\>**
396
-
397
- ### Errors
398
-
399
- | Error Type | Status Code | Content Type |
400
- | --------------- | --------------- | --------------- |
401
- | errors.APIError | 4XX, 5XX | \*/\* |
402
-
403
- ## listFeesFetch
404
-
405
- List fees associated with an account.
406
-
407
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
408
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
409
-
410
- ### Example Usage
411
-
412
- <!-- UsageSnippet language="typescript" operationID="listFeesFetch" method="post" path="/accounts/{accountID}/fees/.fetch" -->
413
- ```typescript
414
- import { Moov } from "@moovio/sdk";
415
-
416
- const moov = new Moov({
417
- xMoovVersion: "v2024.01.00",
418
- security: {
419
- username: "",
420
- password: "",
421
- },
422
- });
423
-
424
- async function run() {
425
- const result = await moov.feePlans.listFeesFetch({
426
- accountID: "55c34e26-269d-4872-8e42-0fa83e3f4b10",
427
- });
428
-
429
- console.log(result);
430
- }
431
-
432
- run();
433
- ```
434
-
435
- ### Standalone function
436
-
437
- The standalone function version of this method:
438
-
439
- ```typescript
440
- import { MoovCore } from "@moovio/sdk/core.js";
441
- import { feePlansListFeesFetch } from "@moovio/sdk/funcs/feePlansListFeesFetch.js";
442
-
443
- // Use `MoovCore` for best tree-shaking performance.
444
- // You can create one instance of it to use across an application.
445
- const moov = new MoovCore({
446
- xMoovVersion: "v2024.01.00",
447
- security: {
448
- username: "",
449
- password: "",
450
- },
451
- });
452
-
453
- async function run() {
454
- const res = await feePlansListFeesFetch(moov, {
455
- accountID: "55c34e26-269d-4872-8e42-0fa83e3f4b10",
456
- });
457
- if (res.ok) {
458
- const { value: result } = res;
459
- console.log(result);
460
- } else {
461
- console.log("feePlansListFeesFetch failed:", res.error);
462
- }
463
- }
464
-
465
- run();
466
- ```
467
-
468
- ### Parameters
469
-
470
- | Parameter | Type | Required | Description |
471
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
472
- | `request` | [operations.ListFeesFetchRequest](../../models/operations/listfeesfetchrequest.md) | :heavy_check_mark: | The request object to use for the request. |
473
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
474
- | `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. |
475
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
476
-
477
- ### Response
478
-
479
- **Promise\<[operations.ListFeesFetchResponse](../../models/operations/listfeesfetchresponse.md)\>**
480
-
481
- ### Errors
482
-
483
- | Error Type | Status Code | Content Type |
484
- | --------------- | --------------- | --------------- |
485
- | errors.APIError | 4XX, 5XX | \*/\* |
486
-
487
- ## listPartnerPricing
488
-
489
- List all partner pricing plans available for use by an account.
490
-
491
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
492
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
493
-
494
- ### Example Usage
495
-
496
- <!-- UsageSnippet language="typescript" operationID="listPartnerPricing" method="get" path="/accounts/{accountID}/partner-pricing" -->
497
- ```typescript
498
- import { Moov } from "@moovio/sdk";
499
-
500
- const moov = new Moov({
501
- xMoovVersion: "v2024.01.00",
502
- security: {
503
- username: "",
504
- password: "",
505
- },
506
- });
507
-
508
- async function run() {
509
- const result = await moov.feePlans.listPartnerPricing({
510
- accountID: "600637f9-c38a-473f-b909-0d5ac537b8a5",
511
- });
512
-
513
- console.log(result);
514
- }
515
-
516
- run();
517
- ```
518
-
519
- ### Standalone function
520
-
521
- The standalone function version of this method:
522
-
523
- ```typescript
524
- import { MoovCore } from "@moovio/sdk/core.js";
525
- import { feePlansListPartnerPricing } from "@moovio/sdk/funcs/feePlansListPartnerPricing.js";
526
-
527
- // Use `MoovCore` for best tree-shaking performance.
528
- // You can create one instance of it to use across an application.
529
- const moov = new MoovCore({
530
- xMoovVersion: "v2024.01.00",
531
- security: {
532
- username: "",
533
- password: "",
534
- },
535
- });
536
-
537
- async function run() {
538
- const res = await feePlansListPartnerPricing(moov, {
539
- accountID: "600637f9-c38a-473f-b909-0d5ac537b8a5",
540
- });
541
- if (res.ok) {
542
- const { value: result } = res;
543
- console.log(result);
544
- } else {
545
- console.log("feePlansListPartnerPricing failed:", res.error);
546
- }
547
- }
548
-
549
- run();
550
- ```
551
-
552
- ### Parameters
553
-
554
- | Parameter | Type | Required | Description |
555
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
556
- | `request` | [operations.ListPartnerPricingRequest](../../models/operations/listpartnerpricingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
557
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
558
- | `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. |
559
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
560
-
561
- ### Response
562
-
563
- **Promise\<[operations.ListPartnerPricingResponse](../../models/operations/listpartnerpricingresponse.md)\>**
564
-
565
- ### Errors
566
-
567
- | Error Type | Status Code | Content Type |
568
- | --------------- | --------------- | --------------- |
569
- | errors.APIError | 4XX, 5XX | \*/\* |
570
-
571
- ## listPartnerPricingAgreements
572
-
573
- List all partner pricing agreements associated with an account.
574
-
575
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
576
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
577
-
578
- ### Example Usage
579
-
580
- <!-- UsageSnippet language="typescript" operationID="listPartnerPricingAgreements" method="get" path="/accounts/{accountID}/partner-pricing-agreements" -->
581
- ```typescript
582
- import { Moov } from "@moovio/sdk";
583
-
584
- const moov = new Moov({
585
- xMoovVersion: "v2024.01.00",
586
- security: {
587
- username: "",
588
- password: "",
589
- },
590
- });
591
-
592
- async function run() {
593
- const result = await moov.feePlans.listPartnerPricingAgreements({
594
- skip: 60,
595
- count: 20,
596
- accountID: "123bfe5e-2288-4146-9d8a-4c07264c3758",
597
- });
598
-
599
- console.log(result);
600
- }
601
-
602
- run();
603
- ```
604
-
605
- ### Standalone function
606
-
607
- The standalone function version of this method:
608
-
609
- ```typescript
610
- import { MoovCore } from "@moovio/sdk/core.js";
611
- import { feePlansListPartnerPricingAgreements } from "@moovio/sdk/funcs/feePlansListPartnerPricingAgreements.js";
612
-
613
- // Use `MoovCore` for best tree-shaking performance.
614
- // You can create one instance of it to use across an application.
615
- const moov = new MoovCore({
616
- xMoovVersion: "v2024.01.00",
617
- security: {
618
- username: "",
619
- password: "",
620
- },
621
- });
622
-
623
- async function run() {
624
- const res = await feePlansListPartnerPricingAgreements(moov, {
625
- skip: 60,
626
- count: 20,
627
- accountID: "123bfe5e-2288-4146-9d8a-4c07264c3758",
628
- });
629
- if (res.ok) {
630
- const { value: result } = res;
631
- console.log(result);
632
- } else {
633
- console.log("feePlansListPartnerPricingAgreements failed:", res.error);
634
- }
635
- }
636
-
637
- run();
638
- ```
639
-
640
- ### Parameters
641
-
642
- | Parameter | Type | Required | Description |
643
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
644
- | `request` | [operations.ListPartnerPricingAgreementsRequest](../../models/operations/listpartnerpricingagreementsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
645
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
646
- | `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. |
647
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
648
-
649
- ### Response
650
-
651
- **Promise\<[operations.ListPartnerPricingAgreementsResponse](../../models/operations/listpartnerpricingagreementsresponse.md)\>**
652
-
653
- ### Errors
654
-
655
- | Error Type | Status Code | Content Type |
656
- | --------------- | --------------- | --------------- |
657
- | errors.APIError | 4XX, 5XX | \*/\* |
658
-
659
- ## listResiduals
660
-
661
- List all residuals associated with an account.
662
-
663
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
664
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
665
-
666
- ### Example Usage
667
-
668
- <!-- UsageSnippet language="typescript" operationID="listResiduals" method="get" path="/accounts/{accountID}/residuals" -->
669
- ```typescript
670
- import { Moov } from "@moovio/sdk";
671
-
672
- const moov = new Moov({
673
- xMoovVersion: "v2024.01.00",
674
- security: {
675
- username: "",
676
- password: "",
677
- },
678
- });
679
-
680
- async function run() {
681
- const result = await moov.feePlans.listResiduals({
682
- skip: 60,
683
- count: 20,
684
- accountID: "8b40b967-ae12-4851-8be2-7b0c39978ce7",
685
- });
686
-
687
- console.log(result);
688
- }
689
-
690
- run();
691
- ```
692
-
693
- ### Standalone function
694
-
695
- The standalone function version of this method:
696
-
697
- ```typescript
698
- import { MoovCore } from "@moovio/sdk/core.js";
699
- import { feePlansListResiduals } from "@moovio/sdk/funcs/feePlansListResiduals.js";
700
-
701
- // Use `MoovCore` for best tree-shaking performance.
702
- // You can create one instance of it to use across an application.
703
- const moov = new MoovCore({
704
- xMoovVersion: "v2024.01.00",
705
- security: {
706
- username: "",
707
- password: "",
708
- },
709
- });
710
-
711
- async function run() {
712
- const res = await feePlansListResiduals(moov, {
713
- skip: 60,
714
- count: 20,
715
- accountID: "8b40b967-ae12-4851-8be2-7b0c39978ce7",
716
- });
717
- if (res.ok) {
718
- const { value: result } = res;
719
- console.log(result);
720
- } else {
721
- console.log("feePlansListResiduals failed:", res.error);
722
- }
723
- }
724
-
725
- run();
726
- ```
727
-
728
- ### Parameters
729
-
730
- | Parameter | Type | Required | Description |
731
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
732
- | `request` | [operations.ListResidualsRequest](../../models/operations/listresidualsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
733
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
734
- | `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. |
735
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
736
-
737
- ### Response
738
-
739
- **Promise\<[operations.ListResidualsResponse](../../models/operations/listresidualsresponse.md)\>**
740
-
741
- ### Errors
742
-
743
- | Error Type | Status Code | Content Type |
744
- | --------------- | --------------- | --------------- |
745
- | errors.APIError | 4XX, 5XX | \*/\* |
746
-
747
- ## getResidual
748
-
749
- Get a residual associated with an account.
750
-
751
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
752
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
753
-
754
- ### Example Usage
755
-
756
- <!-- UsageSnippet language="typescript" operationID="getResidual" method="get" path="/accounts/{accountID}/residuals/{residualID}" -->
757
- ```typescript
758
- import { Moov } from "@moovio/sdk";
759
-
760
- const moov = new Moov({
761
- xMoovVersion: "v2024.01.00",
762
- security: {
763
- username: "",
764
- password: "",
765
- },
766
- });
767
-
768
- async function run() {
769
- const result = await moov.feePlans.getResidual({
770
- accountID: "4c308842-45d1-49c1-98be-7299848b1e20",
771
- residualID: "5f30e43d-1fa8-4834-8788-05a3c27a40d4",
772
- });
773
-
774
- console.log(result);
775
- }
776
-
777
- run();
778
- ```
779
-
780
- ### Standalone function
781
-
782
- The standalone function version of this method:
783
-
784
- ```typescript
785
- import { MoovCore } from "@moovio/sdk/core.js";
786
- import { feePlansGetResidual } from "@moovio/sdk/funcs/feePlansGetResidual.js";
787
-
788
- // Use `MoovCore` for best tree-shaking performance.
789
- // You can create one instance of it to use across an application.
790
- const moov = new MoovCore({
791
- xMoovVersion: "v2024.01.00",
792
- security: {
793
- username: "",
794
- password: "",
795
- },
796
- });
797
-
798
- async function run() {
799
- const res = await feePlansGetResidual(moov, {
800
- accountID: "4c308842-45d1-49c1-98be-7299848b1e20",
801
- residualID: "5f30e43d-1fa8-4834-8788-05a3c27a40d4",
802
- });
803
- if (res.ok) {
804
- const { value: result } = res;
805
- console.log(result);
806
- } else {
807
- console.log("feePlansGetResidual failed:", res.error);
808
- }
809
- }
810
-
811
- run();
812
- ```
813
-
814
- ### Parameters
815
-
816
- | Parameter | Type | Required | Description |
817
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
818
- | `request` | [operations.GetResidualRequest](../../models/operations/getresidualrequest.md) | :heavy_check_mark: | The request object to use for the request. |
819
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
820
- | `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. |
821
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
822
-
823
- ### Response
824
-
825
- **Promise\<[operations.GetResidualResponse](../../models/operations/getresidualresponse.md)\>**
826
-
827
- ### Errors
828
-
829
- | Error Type | Status Code | Content Type |
830
- | --------------- | --------------- | --------------- |
831
- | errors.APIError | 4XX, 5XX | \*/\* |
832
-
833
- ## listResidualFees
834
-
835
- List all fees associated with a residual.
836
-
837
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
838
- you'll need to specify the `/accounts/{accountID}/profile.read` scope.
839
-
840
- ### Example Usage
841
-
842
- <!-- UsageSnippet language="typescript" operationID="listResidualFees" method="get" path="/accounts/{accountID}/residuals/{residualID}/fees" -->
843
- ```typescript
844
- import { Moov } from "@moovio/sdk";
845
-
846
- const moov = new Moov({
847
- xMoovVersion: "v2024.01.00",
848
- security: {
849
- username: "",
850
- password: "",
851
- },
852
- });
853
-
854
- async function run() {
855
- const result = await moov.feePlans.listResidualFees({
856
- skip: 60,
857
- count: 20,
858
- accountID: "6b95293f-c3e7-42b5-98b7-fd9cc8d49685",
859
- residualID: "8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c",
860
- });
861
-
862
- console.log(result);
863
- }
864
-
865
- run();
866
- ```
867
-
868
- ### Standalone function
869
-
870
- The standalone function version of this method:
871
-
872
- ```typescript
873
- import { MoovCore } from "@moovio/sdk/core.js";
874
- import { feePlansListResidualFees } from "@moovio/sdk/funcs/feePlansListResidualFees.js";
875
-
876
- // Use `MoovCore` for best tree-shaking performance.
877
- // You can create one instance of it to use across an application.
878
- const moov = new MoovCore({
879
- xMoovVersion: "v2024.01.00",
880
- security: {
881
- username: "",
882
- password: "",
883
- },
884
- });
885
-
886
- async function run() {
887
- const res = await feePlansListResidualFees(moov, {
888
- skip: 60,
889
- count: 20,
890
- accountID: "6b95293f-c3e7-42b5-98b7-fd9cc8d49685",
891
- residualID: "8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c",
892
- });
893
- if (res.ok) {
894
- const { value: result } = res;
895
- console.log(result);
896
- } else {
897
- console.log("feePlansListResidualFees failed:", res.error);
898
- }
899
- }
900
-
901
- run();
902
- ```
903
-
904
- ### Parameters
905
-
906
- | Parameter | Type | Required | Description |
907
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
908
- | `request` | [operations.ListResidualFeesRequest](../../models/operations/listresidualfeesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
909
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
910
- | `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. |
911
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
912
-
913
- ### Response
914
-
915
- **Promise\<[operations.ListResidualFeesResponse](../../models/operations/listresidualfeesresponse.md)\>**
916
-
917
- ### Errors
918
-
919
- | Error Type | Status Code | Content Type |
920
- | --------------- | --------------- | --------------- |
921
- | errors.APIError | 4XX, 5XX | \*/\* |